Re: r35417 - lyx-devel/trunk/src/insets

[Richard Heck]

On 09/16/2010 09:28 PM, uwesto...@lyx.org wrote:
Author: uwestoehr
Date: Fri Sep 17 03:28:08 2010
New Revision: 35417
URL: http://www.lyx.org/trac/changeset/35417
Log:
InsetLine:
- honor Abdel as author
- reintroduce the /// spacers in the header file because it makes it better 
readable and we do this in all other inset header files

   
These aren't spacers. They're a special sort of comment for use by 
doxygen. Abdel had already put doxygen-related stuff into the header here:

@@ -29,8 +30,11 @@
        /// InsetCommand inherited methods.
        //@{

   
with the "//@{" grouping symbol. I'm not sure it's even legal then to 
put "///" inside, but it may be. Anyone know?

Richard

        docstring screenLabel() const;
+       ///
        static ParamInfo const&  findInfo(std::string const&);
+       ///
        static std::string defaultCommand() { return "rule"; };
+       ///
        static bool isCompatibleCommand(std::string const&  s)
        { return s == "rule"; }
        //@}
@@ -40,17 +44,27 @@
        /// Inset inherited methods.
        //@{
        InsetCode lyxCode() const { return LINE_CODE; }
+       ///
        Dimension const dimension(BufferView const&) const;
+       ///
        int docbook(odocstream&, OutputParams const&) const;
        /// Does nothing at the moment.
        docstring xhtml(XHTMLStream&, OutputParams const&) const;
+       ///
        bool hasSettings() const { return true; }
+       ///
        void metrics(MetricsInfo&, Dimension&) const;
+       ///
        void draw(PainterInfo&  pi, int x, int y) const;
+       ///
        int latex(odocstream&, OutputParams const&) const;
+       ///
        int plaintext(odocstream&, OutputParams const&) const;
+       ///
        void doDispatch(Cursor&  cur, FuncRequest&  cmd);
+       ///
        bool getStatus(Cursor&  cur, FuncRequest const&  cmd, FuncStatus&) 
const;
+       ///
        Inset * clone() const { return new InsetLine(*this); }
        //@}