make doc++ able to generate the source documentation for lyx

[features.git] / src / mathed / array.h

diff --git a/src/mathed/array.h b/src/mathed/array.h
index 91d362062549e8bd1e8f2e37e4221d7206d27748..4683fc13acd5f3ccbb7117757e3318983b0d735a 100644 (file)
--- a/src/mathed/array.h
+++ b/src/mathed/array.h
@@ -20,11 +20,10 @@
 #define byte unsigned char
 #endif
 
-/*@Doc: A resizable array
-  Why is it called "LyXArrayBase" if it is generic? (Lgb)
-  Initially I thought it could be the base class for both mathed's
-  and LyX' kernels data buffer. (Ale)
- 
+/** A resizable array.
+    A general purpose resizable array.
+    @author Alejandro Aguilar Sierra
+    @version January 1996
   */
 class LyxArrayBase  {
 public:
@@ -39,13 +38,16 @@ public:
        };
 
        ///
+       explicit
        LyxArrayBase(int size = ARRAY_STEP);
        ///
        LyxArrayBase(LyxArrayBase const &);
        ///
        ~LyxArrayBase();
    
-       
+       /// Constructs a new array with dx elements starting at pos 
+       LyxArrayBase & operator= (LyxArrayBase const &); 
+
        ///
        int empty() const { return (last == 0); }
    
@@ -82,9 +84,6 @@ public:
        /// Constructs a new array with dx elements starting at pos 
        byte operator[](const int);
 
-       /// Constructs a new array with dx elements starting at pos 
-       LyxArrayBase & operator= (LyxArrayBase const &); 
-
 protected:
        ///
        void Resize(int newsize);