gnue/geas/lib/classdefs gcdparser.h

[Neil Tiffin]

CVSROOT:        /home/cvs
Module name:    gnue
Changes by:     Neil Tiffin <address@hidden>    01/05/14 11:04:32

Modified files:
        geas/lib/classdefs: gcdparser.h 

Log message:
        Add some doxygen comments to see impact.

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/geas/lib/classdefs/gcdparser.h.diff?cvsroot=OldCVS&tr1=1.19&tr2=1.20&r1=text&r2=text

Patches:
Index: gnue/geas/lib/classdefs/gcdparser.h
diff -u gnue/geas/lib/classdefs/gcdparser.h:1.19 
gnue/geas/lib/classdefs/gcdparser.h:1.20
--- gnue/geas/lib/classdefs/gcdparser.h:1.19    Mon May  7 09:34:12 2001
+++ gnue/geas/lib/classdefs/gcdparser.h Mon May 14 11:04:32 2001
@@ -21,14 +21,14 @@
    along with this program; if not, write to the Free Software Foundation,
    Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  
 
-   $Id: gcdparser.h,v 1.19 2001/05/07 16:34:12 ntiffin Exp $
+   $Id: gcdparser.h,v 1.20 2001/05/14 18:04:32 ntiffin Exp $
    
 */
 
 
 /** \file gcdparser.h
- * \brief This file should not be used outside of the ODL class library
- * This contains typedefs and function prototypes used inside the
+ * \warning This file should not be used outside of the ODL class library.
+ * \brief Contains typedefs and function prototypes used inside the
  * GCD parser.
  */
 
@@ -40,9 +40,11 @@
 extern int            yyerrorcount;
 extern int            yywarncount;
 
+/** \struct _odl_base
+ *  \brief Generic data for an odl object.
+ */
 struct _odl_base
 {
-  /* generic data */
   char                 *name;
   char                 *fullname;
   char                 *mangledname;
@@ -53,44 +55,50 @@
   odl_tree             *tree;
 };
 
-                              /* stores modules, classes, etc */
+/** \struct _odl_container
+ *  \brief Stores modules, classes and any other containers.
+ */
 struct _odl_container
 {
   struct _odl_base      base;
-  /* generic data */
-  GList                *contents;       /* must be an instance of _odl_base */
-  /* business class data */
-  gboolean              istype; /* true if 'type' keyword was used */
+                                    /* generic data */
+  GList                *contents;   /* must be an instance of _odl_base */
+                                    /* business class data */
+  gboolean              istype;     /* true if 'type' keyword was used */
   char                 *orderby;
   GList                *parents;
   GList                *indexes;
 };
 
- /* items that can not have containers */
+/** \struct _odl_item
+ *  \brief Stores items that can not have containers.
+ */
 struct _odl_item
 {
   struct _odl_base      base;
-  /* class fields - generic data */
+                                        /* class fields - generic data */
   enum odl_fieldtype    fieldtype;
   enum odl_datatype     datatype;
   char                 *datatypeclass;  /* when datatype == DT_class */
   unsigned long int     properties;
-  /* basic fields */
+                                        /* basic fields */
   char                 *format;
   char                 *defaultval;
   char                 *tmpdefault;
-  /* lookup/reference/list */
-  /* readonly fields */
+                                        /* lookup/reference/list */
+                                        /* readonly fields */
   char                 *sourcefield;
   char                 *sourceclass;
   odl_namelist         *this_fields;
   odl_namelist         *source_fields;
-  signed long int       bounds;
-  /* method */
+  signed long int       bounds;         /*     -1 = reference,    */
+                                        /*      0 = unlimited list, */
+                                        /* +other = bounded list, not 
implemented */
+                                        /* method */
   odl_argumentlist     *arguments;
-  /* calculated */
+                                        /* calculated */
   char                 *calculation;
-  /* enum */
+                                        /* enum */
   GList                *elements;
 };