comments added

[libfirm] / ir / tr / entity.h

diff --git a/ir/tr/entity.h b/ir/tr/entity.h
index 45176fb..89d23db 100644 (file)
--- a/ir/tr/entity.h
+++ b/ir/tr/entity.h
@@ -72,9 +72,22 @@ typedef struct ir_graph ir_graph;
  *   entity - An abstract data type to represent program entites.
  * NOTE
  *
- *   ... not documented ...
- *
  * ATTRIBUTES
+ *   owner      A compound type this entity is a part of.
+ *   type       The type of this entity.
+ *   name       The string that represents this entity in the source program.
+ *   allocation A flag saying whether the entity is dynamically or statically
+ *              allocated (values: dynamic_allocated,  static_allocated).
+ *              @@@ Does this make sense???
+ *   visibility A flag indicating the visibility of this entity (values: local,
+ *              external_visible,  external_allocated)
+ *   offset     The offset of the entity within the compound object.  Only set
+ *              if IR in the state "@@@"  Wie nennen wir den??
+ *   overwrites A list of entities overwritten by this entity.  This list is only
+ *              existent if the owner of this entity is a class.  The members in
+ *              this list must be entities of super classes.
+ *   irg        If the entity is a method this is the ir graph that represents the
+ *              code of the method.
  *
  *
  *  These fields can only be accessed via access functions.
@@ -157,7 +170,10 @@ void      set_entity_offset (entity *ent, int offset);
 /* Overwrites is a field that specifies that an access to the overwritten
    entity in the supertype must use this entity.  It's a list as with
    multiple inheritance several enitites can be overwritten.  This field
-   is mostly useful for method entities. */
+   is mostly useful for method entities.
+   If a Sel node selects an entity that is overwritten by other entities it
+   must return a pointer to the entity of the dynamic type of the pointer
+   that is passed to it.  Lowering of the Sel node must assure this. */
 void    add_entity_overwrites   (entity *ent, entity *overwritten);
 int     get_entity_n_overwrites (entity *ent);
 entity *get_entity_overwrites   (entity *ent, int pos);