rename type entity into ir_entity
[libfirm] / ir / stat / pattern_dmp.h
index d270fea..0c4027d 100644 (file)
@@ -6,52 +6,57 @@
 typedef struct _pattern_dumper_t pattern_dumper_t;
 
 /**
- * starts a new pattern
+ * Starts a new pattern.
  */
 void pattern_dump_new_pattern(pattern_dumper_t *self, counter_t *cnt);
 
 /**
- * Finishes current pattern
+ * Finish the current pattern.
  */
 void pattern_dump_finish_pattern(pattern_dumper_t *self);
 
 /**
- * Dumps a node
+ * Dumps a node.
  */
 void pattern_dump_node(pattern_dumper_t *self, unsigned id, unsigned op_code, unsigned mode_code, void *attr);
 
 /**
- * Dump a ref
+ * Dump a ref.
  */
 void pattern_dump_ref(pattern_dumper_t *self, unsigned id);
 
 /**
- * Dump an edge
+ * Dump an edge.
+ *
+ * @param tgt       The target ID
+ * @param src       The source ID
+ * @param pos       The edge position
+ * @param mode_code The mode_code of the edge
  */
-void pattern_dump_edge(pattern_dumper_t *self, unsigned id, unsigned parent, unsigned position);
+void pattern_dump_edge(pattern_dumper_t *self, unsigned tgt, unsigned src, unsigned pos, unsigned mode_code);
 
 /**
- * Start children dumper
+ * Start the children dumper.
  */
 void pattern_start_children(pattern_dumper_t *self, unsigned id);
 
 /**
- * finishes childred dumper
+ * Finish the children dumper.
  */
 void pattern_finish_children(pattern_dumper_t *self, unsigned id);
 
 /**
- * finishes dumper, destroyes the dumper object
+ * Finish the dumper, destroys the dumper object
  */
 void pattern_end(pattern_dumper_t *self);
 
 /**
- * pattern dumper factory for text dumper
+ * Pattern dumper factory for text dumper.
  */
 pattern_dumper_t *new_text_dumper(void);
 
 /**
- * pattern dumper factory for vcg dumper
+ * Pattern dumper factory for vcg dumper.
  *
  * @param vcg_name    name of the VCG file
  * @param max_pattern maximum number of pattern to be dumped