From: Michael Beck <beck@ipd.info.uni-karlsruhe.de>
Date: Tue, 14 Jan 2003 16:16:31 +0000 (+0000)
Subject: Convert field descriptions into doxygen style comments.
X-Git-Url: http://nsz.repo.hu/git/?a=commitdiff_plain;h=6cff544013370564e4657f68f37f38415ec1a445;p=libfirm

Convert field descriptions into doxygen style comments.

[r626]
---

diff --git a/ir/tr/type_t.h b/ir/tr/type_t.h
index b8ae15fc4..619ce88dd 100644
--- a/ir/tr/type_t.h
+++ b/ir/tr/type_t.h
@@ -16,59 +16,59 @@
  */
 
 typedef struct {
-  entity **members;    /* fields and methods of this class */
-  type   **subtypes;   /* direct subtypes */
-  type   **supertypes; /* direct supertypes */
+  entity **members;    /**< fields and methods of this class */
+  type   **subtypes;   /**< direct subtypes */
+  type   **supertypes; /**< direct supertypes */
   peculiarity peculiarity;
-  int dfn;             /* number used for 'instanceof' operator */
+  int dfn;             /**< number used for 'instanceof' operator */
 } cls_attr;
 
 typedef struct {
-  entity **members;    /* fields of this struct. No method entities
+  entity **members;    /**< fields of this struct. No method entities
 			  allowed. */
 } stc_attr;
 
 typedef struct {
-  int n_params;        /* number of parameters */
-  type **param_type;   /* code generation needs this information.
+  int n_params;        /**< number of parameters */
+  type **param_type;   /**< code generation needs this information.
                           @@@ Should it be generated by the frontend,
                           or does this impose unnecessary work for
                           optimizations that change the parameters of
                           methods? */
-  int n_res;           /* number of results */
-  type **res_type;     /* array with result types */
-  variadicity variadicity; /* variadicity of the method */
+  int n_res;           /**< number of results */
+  type **res_type;     /**< array with result types */
+  variadicity variadicity; /**< variadicity of the method */
 } mtd_attr;
 
 typedef struct {
   int     n_types;
   /* type  **unioned_type; * a list of unioned types. */
   /* ident **delim_names;  * names of the union delimiters. */
-  entity **members;    /* fields of this union. No method entities
+  entity **members;    /**< fields of this union. No method entities
 			  allowed.  */
 
 } uni_attr;
 
 typedef struct {
-  int   n_dimensions;  /* Number of array dimensions.  */
-  ir_node **lower_bound;   /* Lower bounds of dimensions.  Usually all 0. */
-  ir_node **upper_bound;   /* Upper bounds or dimensions. */
-  int *order;              /* Ordering of dimensions. */
-  type *element_type;  /* The type of the array elements. */
-  entity *element_ent; /* Entity for the array elements, to be used for
+  int   n_dimensions;  /**< Number of array dimensions.  */
+  ir_node **lower_bound;   /**< Lower bounds of dimensions.  Usually all 0. */
+  ir_node **upper_bound;   /**< Upper bounds or dimensions. */
+  int *order;              /**< Ordering of dimensions. */
+  type *element_type;  /**< The type of the array elements. */
+  entity *element_ent; /**< Entity for the array elements, to be used for
 			  element selection with Sel. */
 } arr_attr;
 
 typedef struct {
-  int      n_enums;    /* Number of enumerators. */
-  tarval **enumer;     /* Contains all constants that represent a member
+  int      n_enums;    /**< Number of enumerators. */
+  tarval **enumer;     /**< Contains all constants that represent a member
                           of the enum -- enumerators. */
-  ident  **enum_nameid;/* Contains the names of the enum fields as specified by
+  ident  **enum_nameid;/**< Contains the names of the enum fields as specified by
                           the source program */
 } enm_attr;
 
 typedef struct {
-  type *points_to;     /* The type of the enitity the pointer points to. */
+  type *points_to;     /**< The type of the enitity the pointer points to. */
 } ptr_attr;
 
 /*
@@ -96,15 +96,15 @@ struct type {
   firm_kind kind;
   tp_op *type_op;
   ident *name;
-  type_state state;        /* Represents the types state: layout undefined or
+  type_state state;        /**< Represents the types state: layout undefined or
 			      fixed. */
-  int size;                /* Size of an entity of this type.  This is determined
+  int size;                /**< Size of an entity of this type.  This is determined
 			      when fixing the layout of this class.  Size must be
 			      given in bytes. */
-  ir_mode *mode;           /* The mode for atomic types */
-  unsigned long visit;     /* visited counter for walks of the type information */
-  void *link;              /* holds temporary data - like in irnode_t.h */
-  struct dbg_info* dbi;    /* A pointer to information for debug support. */
+  ir_mode *mode;           /**< The mode for atomic types */
+  unsigned long visit;     /**< visited counter for walks of the type information */
+  void *link;              /**< holds temporary data - like in irnode_t.h */
+  struct dbg_info* dbi;    /**< A pointer to information for debug support. */
   tp_attr attr;            /* type kind specific fields. This must be the last
 			      entry in this struct!  Varying size! */
 };