Added missing API docu, improved existing API docu

[libfirm] / include / libfirm / irextbb.h

diff --git a/include/libfirm/irextbb.h b/include/libfirm/irextbb.h
index 7ce95cf..e346617 100644 (file)
--- a/include/libfirm/irextbb.h
+++ b/include/libfirm/irextbb.h
@@ -22,7 +22,6 @@
  * @brief   Extended basis block support.
  * @author  Michael Beck
  * @date    5.2005
- * @version $Id$
  */
 #ifndef FIRM_ANA_IREXTBB_H
 #define FIRM_ANA_IREXTBB_H
@@ -31,13 +30,6 @@
 #include "execfreq.h"
 #include "begin.h"
 
-/** Flags for extended basic block state. */
-typedef enum {
-  ir_extblk_info_none    = 0,  /**< No extended basic block information is constructed. Default. */
-  ir_extblk_info_valid   = 1,  /**< Extended basic block information is valid. */
-  ir_extblk_info_invalid = 2   /**< Extended basic block information is constructed but invalid. */
-} irg_extblk_info_state;
-
 /* type of callback function for ir_graph walk */
 #ifndef _EXTBB_WALK_FUNC_TYPEDEF_
 #define _EXTBB_WALK_FUNC_TYPEDEF_
@@ -72,14 +64,14 @@ FIRM_API void compute_extbb_execfreqs(ir_graph *irg, ir_exec_freq *execfreqs);
 FIRM_API void free_extbb(ir_graph *irg);
 
 /**
- * Return the extended block of a node.
+ * Returns the extended block of a node.
  *
  * @param node  the node
  */
 FIRM_API ir_extblk *get_nodes_extbb(const ir_node *node);
 
 /**
- * Gets the visited counter of an extended block.
+ * Returns the visited counter of an extended block.
  *
  * @param blk  the extended basic block
  */
@@ -133,14 +125,14 @@ FIRM_API void *get_extbb_link(const ir_extblk *blk);
 FIRM_API void set_extbb_link(ir_extblk *blk, void *link);
 
 /**
- * Return the number of basic blocks of an extended block.
+ * Returns the number of basic blocks of an extended block.
  *
  * @param blk  the extended basic block
  */
 FIRM_API int get_extbb_n_blocks(const ir_extblk *blk);
 
 /**
- * Return the i'th basic block of an extended block.
+ * Returns the i'th basic block of an extended block.
  *
  * @param blk  the extended basic block
  * @param pos  the position
@@ -148,14 +140,14 @@ FIRM_API int get_extbb_n_blocks(const ir_extblk *blk);
 FIRM_API ir_node *get_extbb_block(const ir_extblk *blk, int pos);
 
 /**
- * Return the leader basic block of an extended block.
+ * Returns the leader basic block of an extended block.
  *
  * @param blk  the extended basic block
  */
 FIRM_API ir_node *get_extbb_leader(const ir_extblk *blk);
 
 /**
- * Return the node number of an extended block.
+ * Returns the node number of an extended block.
  * Its the block number of the leader block
  *
  * @param blk  the extended basic block
@@ -172,7 +164,7 @@ FIRM_API long get_extbb_node_nr(const ir_extblk *blk);
  *               visited
  * @param env  - environment, passed to pre and post
  *
- * This function Walks only over Block nodes in the graph. Has it's own visited
+ * This function Walks only over Block nodes in the graph. Has its own visited
  * flag, so that it can be interleaved with the other walker.
  * If a none block is passed, starts at the block this node belongs to.
  * If end is passed also visits kept alive blocks. Does not use the link field.