documentation: Update information about ir_graph.

[libfirm] / include / libfirm / callgraph.h

diff --git a/include/libfirm/callgraph.h b/include/libfirm/callgraph.h
index ddfa2c2..240ddd8 100644 (file)
--- a/include/libfirm/callgraph.h
+++ b/include/libfirm/callgraph.h
@@ -22,7 +22,18 @@
  * @brief       Representation and computation of the callgraph.
  * @author      Goetz Lindenmaier
  * @date        21.7.2004
- * @brief
+ * @brief       callgraph analysis
+ */
+#ifndef FIRM_ANA_CALLGRAPH_H
+#define FIRM_ANA_CALLGRAPH_H
+
+#include "firm_types.h"
+#include "begin.h"
+
+/**
+ * @ingroup irana
+ * @defgroup callgraph Callgraph
+ *
  *  This file contains the representation of the callgraph.
  *  The nodes of the call graph are ir_graphs.  The edges between
  *  the nodes are calling relations.  I.e., if method a calls method
@@ -35,12 +46,8 @@
  *  Finally this file contains an algorithm that computes backedges
  *  in the callgraph, i.e., the algorithm finds possibly recursive calls.
  *  The algorithm computes an upper bound of all recursive calls.
+ * @{
  */
-#ifndef FIRM_ANA_CALLGRAPH_H
-#define FIRM_ANA_CALLGRAPH_H
-
-#include "firm_types.h"
-#include "begin.h"
 
 /** Flag to indicate state of callgraph. */
 typedef enum {
@@ -60,7 +67,7 @@ FIRM_API void set_irp_callgraph_state(irp_callgraph_state s);
 FIRM_API size_t get_irg_n_callers(const ir_graph *irg);
 
 /** Returns the caller at position pos. */
-ir_graph *get_irg_caller(const ir_graph *irg, size_t pos);
+FIRM_API ir_graph *get_irg_caller(const ir_graph *irg, size_t pos);
 
 /** Returns non-zero if the caller at position pos is "a backedge", i.e. a recursion. */
 FIRM_API int is_irg_caller_backedge(const ir_graph *irg, size_t pos);
@@ -164,6 +171,8 @@ FIRM_API void set_irp_loop_nesting_depth_state(loop_nesting_depth_state s);
 /** Marks the nesting depth state of the program representation as inconsistent. */
 FIRM_API void set_irp_loop_nesting_depth_state_inconsistent(void);
 
+/** @} */
+
 #include "end.h"
 
 #endif