small cleanup, doxygen, formatting changes

[lyx.git] / src / mathed / math_macrotemplate.h

diff --git a/src/mathed/math_macrotemplate.h b/src/mathed/math_macrotemplate.h
index bf34520575337c80772ea773fada396d8129b7cb..7fa1f4b2a4749f69dbe5ef4fc8880be466a22cd4 100644 (file)
--- a/src/mathed/math_macrotemplate.h
+++ b/src/mathed/math_macrotemplate.h
@@ -9,49 +9,53 @@
 
 class MathMacro;
 
-/// This class contains the macro definition
-class MathMacroTemplate: public MathParInset {
-  public:
-  /// A template constructor needs all the data
-    explicit
-    MathMacroTemplate(string const &, int na = 0, int f = 0);
-    ///
-    ~MathMacroTemplate();
-    ///
-    void draw(Painter &, int, int);
-    ///
-    void Metrics();
-    ///
-    void WriteDef(std::ostream &, bool fragile);
-    /// useful for special insets
-    void  setTCode(MathedTextCodes t);
-    ///
-    MathedTextCodes getTCode() const;
-    /// 
-    void setArgument(MathedArray *, int i= 0);
-    /// Number of arguments
-    int getNoArgs() const;
-    ///
-    void GetMacroXY(int, int &, int &) const;
-    ///
-    MathParInset * getMacroPar(int) const;
-    ///
-    void SetMacroFocus(int &, int, int);
-    ///
-    void setEditMode(bool);
-
-    /// Replace the appropriate arguments with a specific macro's data
-    void update(MathMacro * m = 0);
+/** This class contains the macro definition
+    \author Alejandro Aguilar Sierra
+ */
+class MathMacroTemplate : public MathParInset {
+public:
+       /// A template constructor needs all the data
+       explicit
+       MathMacroTemplate(string const &, int na = 0, int f = 0);
+       ///
+       ~MathMacroTemplate();
+       ///
+       void draw(Painter &, int, int);
+       ///
+       void Metrics();
+       ///
+       void WriteDef(std::ostream &, bool fragile);
+       /// useful for special insets
+       void  setTCode(MathedTextCodes t);
+       ///
+       MathedTextCodes getTCode() const;
+       /// 
+       void setArgument(MathedArray *, int i= 0);
+       /// Number of arguments
+       int getNoArgs() const;
+       ///
+       void GetMacroXY(int, int &, int &) const;
+       ///
+       MathParInset * getMacroPar(int) const;
+       ///
+       void SetMacroFocus(int &, int, int);
+       ///
+       void setEditMode(bool);
+       
+       /// Replace the appropriate arguments with a specific macro's data
+       void update(MathMacro * m = 0);
+       ///
+       short flags() const {
+               return flags_;
+       }
 private:
-    ///
-    short flags;
-    ///
-    MathedTextCodes tcode;
-    ///
-    std::vector<MathMacroArgument> args_;
-    ///
-    int nargs;
-    ///
-    friend class MathMacro;
+       ///
+       short flags_;
+       ///
+       MathedTextCodes tcode_;
+       ///
+       std::vector<MathMacroArgument> args_;
+       ///
+       int nargs_;
 };
 #endif