Added missing API docu, improved existing API docu

[libfirm] / include / libfirm / execfreq.h

diff --git a/include/libfirm/execfreq.h b/include/libfirm/execfreq.h
index b15a473..a301e91 100644 (file)
--- a/include/libfirm/execfreq.h
+++ b/include/libfirm/execfreq.h
@@ -22,7 +22,6 @@
  * @brief       Compute an estimate of basic block executions.
  * @author      Adam M. Szalkowski
  * @date        28.05.2006
- * @version     $Id$
  */
 #ifndef FIRM_ANA_EXECFREQ_H
 #define FIRM_ANA_EXECFREQ_H
@@ -30,31 +29,37 @@
 #include "firm_types.h"
 #include "begin.h"
 
-struct ir_exec_freq;
-
 /**
- * Create execfreq structure (to be used with set_execfreq)
+ * @ingroup irana
+ * @defgroup execfreq Basic Block Execution Frequency
+ * @{
  */
-FIRM_DLL ir_exec_freq *create_execfreq(ir_graph *irg);
 
-/**
- * Set execution frequency of a basic block
- */
-FIRM_DLL void set_execfreq(ir_exec_freq *ef, const ir_node *block, double freq);
+/** Creates execfreq structure (to be used with set_execfreq) */
+FIRM_API ir_exec_freq *create_execfreq(ir_graph *irg);
 
 /**
- * Create execfreq structure and initialize with estimated frequencies
+ * Sets execution frequency of a basic block
  */
-FIRM_DLL ir_exec_freq *compute_execfreq(ir_graph *irg, double loop_weight);
+FIRM_API void set_execfreq(ir_exec_freq *ef, const ir_node *block, double freq);
 
-FIRM_DLL void free_execfreq(ir_exec_freq *ef);
+/** Creates execfreq structure and initialize with estimated frequencies. */
+FIRM_API ir_exec_freq *compute_execfreq(ir_graph *irg, double loop_weight);
 
-FIRM_DLL double get_block_execfreq(const ir_exec_freq *ef,
+/** Frees memory occupied by execution frequency structure @p ef. */
+FIRM_API void free_execfreq(ir_exec_freq *ef);
+
+/** Returns execution frequency of block @p block. */
+FIRM_API double get_block_execfreq(const ir_exec_freq *ef,
                                    const ir_node *block);
 
-FIRM_DLL unsigned long get_block_execfreq_ulong(const ir_exec_freq *ef,
+/** Returns execution frequency of block @p block, scaled into the range
+ * of an unsigned long type. */
+FIRM_API unsigned long get_block_execfreq_ulong(const ir_exec_freq *ef,
                                                 const ir_node *block);
 
+/** @} */
+
 #include "end.h"
 
 #endif