ir_visibility cleanup

[libfirm] / include / libfirm / irouts.h

diff --git a/include/libfirm/irouts.h b/include/libfirm/irouts.h
index 7082292..a4c2e44 100644 (file)
--- a/include/libfirm/irouts.h
+++ b/include/libfirm/irouts.h
@@ -37,20 +37,20 @@
  * @{
  */
 
-/** returns the number of successors of the node: */
+/** Returns the number of successors of the node: */
 FIRM_API int get_irn_n_outs(const ir_node *node);
 
-/** Get the User of a node from the Def-Use edge at position pos. */
+/** Returns the User of a node from the Def-Use edge at position pos. */
 FIRM_API ir_node *get_irn_out(const ir_node *def, int pos);
 
 /**
- * Get the User and its input position from the Def-Use edge of def
+ * Returns the User and its input position from the Def-Use edge of def
  * at position pos.
  */
 FIRM_API ir_node *get_irn_out_ex(const ir_node *def, int pos, int *in_pos);
 
 /**
- * Set the User at position pos.
+ * Sets the User at position pos.
  *
  * @param def     the Def node
  * @param pos     the number of the Def-Use edge tat is modified
@@ -59,10 +59,10 @@ FIRM_API ir_node *get_irn_out_ex(const ir_node *def, int pos, int *in_pos);
  */
 FIRM_API void set_irn_out(ir_node *def, int pos, ir_node *use, int in_pos);
 
-/** Return the number of control flow successors, ignore keep-alives. */
+/** Returns the number of control flow successors, ignore keep-alives. */
 FIRM_API int get_Block_n_cfg_outs(const ir_node *node);
 
-/** Return the number of control flow successors, honor keep-alives. */
+/** Returns the number of control flow successors, honor keep-alives. */
 FIRM_API int get_Block_n_cfg_outs_ka(const ir_node *node);
 
 /** Access predecessor n, ignore keep-alives. */
@@ -87,7 +87,7 @@ FIRM_API void irg_out_block_walk(ir_node *node, irg_walk_func *pre,
                                  irg_walk_func *post, void *env);
 
 /**
- * returns 1 if outs have been computed for a node, 0 otherwise.
+ * Returns 1 if outs have been computed for a node, 0 otherwise.
  *
  * this is useful to detect newly created nodes that have no outs set yet
  */
@@ -100,11 +100,15 @@ FIRM_API int get_irn_outs_computed(const ir_node *node);
  * "op_pin_state_floats".   Optimizes Tuple nodes.
  */
 FIRM_API void compute_irg_outs(ir_graph *irg);
+/** Recomputes out edges for each graph where it is necessary */
 FIRM_API void compute_irp_outs(void);
 
+/** Recomputes out edges if necessary */
 FIRM_API void assure_irg_outs(ir_graph *irg);
 
+/** Frees memory occupied by out edges datastructures */
 FIRM_API void free_irg_outs(ir_graph *irg);
+/** Frees memory occupied by out edges datastructures in the whole program */
 FIRM_API void free_irp_outs(void);
 
 /** @} */