More doxygen docu.

[r619]

diff --git a/ir/ident/ident.h b/ir/ident/ident.h
index 28d39b9..d460888 100644 (file)
--- a/ir/ident/ident.h
+++ b/ir/ident/ident.h
@@ -7,6 +7,14 @@
 * Authors: Martin Trapp, Christian Schaefer
 */
 
+/**
+ * @file ident.h
+ *
+ * Declarations for identifiers in the firm library
+ *
+ * Identifiers are used in the firm library. This is the interface to it.
+ */
+
 /* $Id$ */
 
 # ifndef _IDENT_H_
@@ -16,100 +24,88 @@
 # include <assert.h>
 # include "firm_common.h"
 
-/**
- *
- *   - identifiers in the firm library
- *  Identifiers are used in the firm library. This is the interface to it.
- */
-
 /* Identifiers */
+
 /**
- *
  *  the abstract data type ident
  */
 typedef const struct set_entry ident;
 
 /**
- *
- *  store a string and create an ident
+ *  Store a string and create an ident.
  *  Stores a string in the ident module and returns a handle for the string.
  *  Copies the string.
- *  @param str - the string (or whatever) which shall be stored
- *  @param len - the length of the data in bytes
- *  @return id - a handle for the generated ident
+ *
+ * @param str - the string (or whatever) which shall be stored
+ * @param len - the length of the data in bytes
+ *
+ * @return id - a handle for the generated ident
+ *
  * @see id_to_str, id_to_strlen
- * @see
  */
 INLINE ident      *id_from_str (const char *str, int len);
 
 /**
+ * Returns a string represented by an ident.
+ * Returns the string cp represented by id. This string cp is not
+ * NULL terminated! The string may not be changed.
+ *
+ * @param id - the ident
+ *
+ * @return cp - a string
  *
- *  return a string represented by an ident
- *  Returns the string cp represented by id. This string cp is not
- *  Null terminated!  The string may not be changed.
- *  @param id - the ident
- *  @return cp - a string
  * @see id_from_str, id_to_strlen
- * @see
  */
 INLINE const char *id_to_str   (ident *id);
 
 /**
+ * Returns the length of a string represented by an ident.
+ *
+ * @param id - the ident
+ *
+ * @return len - the length of the string
  *
- *  return the length of a string represented by an ident
- *  Returns the length of string represented by id.
- *  @param id - the ident
- *  @return len - the length of the string
  * @see id_from_str, id_to_str
- * @see
  */
 INLINE int  id_to_strlen(ident *id);
 
 /**
+ * Returns true if prefix is prefix of an ident.
  *
+ * @param prefix - the prefix
+ * @param id     - the ident
  *
- *  Returns true if prefix is prefix of id.
- *  @param prefix - the prefix
- *  @param id - the ident
  * @see id_from_str, id_to_str, id_is_prefix
- * @see
  */
-/*  */
 int id_is_prefix (ident *prefix, ident *id);
 
 /**
+ * Returns true if suffix is suffix of id.
  *
+ * @param suffix - the suffix
+ * @param id     - the ident
  *
- *  Returns true if suffix is suffix of id.
- *  @param suffix - the suffix
- *  @param id - the ident
  * @see id_from_str, id_to_str, id_is_prefix
- * @see
  */
-/*  */
 int id_is_suffix (ident *suffix, ident *id);
 
 /**
+ * Prints the ident to stdout.
  *
+ * @param id - The ident to print.
  *
- *  Prints the ident to stdout.
- *  @param The ident to print.
  * @see id_from_str, id_to_str, id_is_prefix, fprint_id
- * @see
  */
-/*  */
 int print_id (ident *id);
 
 /**
+ * Prints the ident to the file passed.
  *
+ * @param F  - file pointer to print the ident to.
+ * @param id - The ident to print and the file.
  *
- *  Prints the ident to the file passed.
- *  @param The ident to print and the file.
  * @see id_from_str, id_to_str, id_is_prefix, print_id
- * @see
  */
-/*  */
 int fprint_id (FILE *F, ident *id);
 
-
 # endif /* _IDENT_H_ */