X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;ds=sidebyside;f=type.h;h=065966332ff55793ffa1bc9fab070ebcb08942fe;hb=211aaabd26e2f4eab27d054b1984c66904fb45c2;hp=7e0753611d3e1ad7e8f9dc9936b6a4a36878424a;hpb=35c00466da38c90e5fb00b3590ab9b7496501860;p=cparser

diff --git a/type.h b/type.h
index 7e07536..0659663 100644
--- a/type.h
+++ b/type.h
@@ -32,10 +32,9 @@ typedef unsigned char il_alignment_t;
 /* note that the constant values represent the rank of the types as defined
  * in § 6.3.1 */
 typedef enum atomic_type_kind_t {
-	ATOMIC_TYPE_INVALID = 0,
-	ATOMIC_TYPE_VOID,
+	ATOMIC_TYPE_VOID = 1,
 	ATOMIC_TYPE_BOOL,
-	ATOMIC_TYPE_WCHAR_T,
+	ATOMIC_TYPE_WCHAR_T, /* only used in C++, in C code wchar_t is a pp-macro */
 	ATOMIC_TYPE_CHAR,
 	ATOMIC_TYPE_SCHAR,
 	ATOMIC_TYPE_UCHAR,
@@ -104,6 +103,11 @@ typedef union  type_t                type_t;
 void init_types(unsigned machine_size);
 void exit_types(void);
 
+/**
+ * Prints a type.
+ *
+ * @param type   The type.
+ */
 void print_type(const type_t *type);
 
 /**
@@ -121,55 +125,107 @@ typedef enum QualifierSeparators {
 
 void print_type_qualifiers(type_qualifiers_t qualifiers, QualifierSeparators);
 
+/**
+ * Prints an enum definition.
+ *
+ * @param declaration  The enum's type declaration.
+ */
 void print_enum_definition(const enum_t *enume);
+
+/**
+ * Print the compound part of a compound type.
+ */
 void print_compound_definition(const compound_t *compound);
 
 void inc_type_visited(void);
 
 /**
- * returns true if type contains integer numbers
+ * Returns true if the given type is an integer type.
+ *
+ * @param type  The type to check.
+ * @return True if type is an integer type.
  */
 bool is_type_integer(const type_t *type);
 
 /**
  * Returns true if the given type is an enum type.
+ *
+ * @param type  The type to check.
+ * @return True if type is an enum type.
  */
 bool is_type_enum(const type_t *type);
 
 /**
- * return true if type contains signed numbers
+ * Returns true if the given type is a signed type.
+ *
+ * @param type  The type to check.
+ * @return True if type is a signed type.
  */
 bool is_type_signed(const type_t *type);
 
 /**
- * returns true if type contains floating point numbers
+ * Returns true if the given type is a floating point type.
+ *
+ * @param type  The type to check.
+ * @return True if type is a floating point type.
  */
 bool is_type_float(const type_t *type);
 
 /**
- * returns true if type contains complex numbers
+ * Returns true if the given type is a complex type.
+ *
+ * @param type  The type to check.
+ * @return True if type is a complex type.
  */
 bool is_type_complex(const type_t *type);
 
+/**
+ * Returns true if the given type is an integer or float type.
+ *
+ * @param type  The type to check.
+ * @return True if type is an integer or float type.
+ */
 bool is_type_real(const type_t *type);
 
 /**
- * returns true if the type is an arithmetic type (§6.2.5 clause 18)
+ * Returns true if the type is an arithmetic type (§6.2.5 clause 18)
+ *
+ * @param type  The type to check.
+ * @return True if type represents an arithmetic type.
  */
 bool is_type_arithmetic(const type_t *type);
 
 /**
- * returns true if the type is a scalar type (§6.2.5 clause 21)
+ * Returns true if the type is a scalar type (§6.2.5 clause 21)
+ *
+ * @param type  The type to check.
+ * @return True if type represents a scalar type.
  */
 bool is_type_scalar(const type_t *type);
 
+/**
+ * Check if a given type is incomplete.
+ *
+ * @param type  The type to check.
+ * @return True if the given type is incomplete (ie. just forward).
+ */
 bool is_type_incomplete(const type_t *type);
 
 bool is_type_object(const type_t *type);
 
+/**
+ * Check if two types are compatible.
+ */
 bool types_compatible(const type_t *type1, const type_t *type2);
 
+/**
+ * Returns the unqualified type of a given type.
+ *
+ * @param type  The type.
+ * @returns The unqualified type.
+ */
 type_t *get_unqualified_type(type_t *type);
+
 type_t *get_qualified_type(type_t*, type_qualifiers_t);
 type_t *skip_typeref(type_t *type);