From 993376697dc65bdb0e069436520e92bbbadfd0a8 Mon Sep 17 00:00:00 2001
From: =?utf8?q?G=C3=B6tz=20Lindenmaier?= <goetz@ipd.info.uni-karlsruhe.de>
Date: Mon, 17 Jan 2005 13:40:14 +0000
Subject: [PATCH] comments

[r4937]
---
 ir/ana/callgraph.h |  5 ++++-
 ir/ana/cgana.h     |  6 +++---
 ir/ana/trouts.c    |  6 +++---
 ir/ana/trouts.h    | 32 ++++++++++++++++----------------
 4 files changed, 26 insertions(+), 23 deletions(-)

diff --git a/ir/ana/callgraph.h b/ir/ana/callgraph.h
index abedeef00..ad33346ac 100644
--- a/ir/ana/callgraph.h
+++ b/ir/ana/callgraph.h
@@ -71,8 +71,11 @@ int       get_irg_loop_depth(ir_graph *irg);
 int       get_irg_recursion_depth(ir_graph *irg);
 
 
-/** Construct and destruct the callgraph. */
+/** Construct the callgraph. Expects callee information, i.e.,
+    irg_callee_info_consistent must be set.  This can be computed with
+    cgana(). */
 void compute_callgraph(void);
+/** Destruct the callgraph. */
 void free_callgraph(void);
 
 
diff --git a/ir/ana/cgana.h b/ir/ana/cgana.h
index 799bbdc64..ca85bd75c 100644
--- a/ir/ana/cgana.h
+++ b/ir/ana/cgana.h
@@ -69,14 +69,14 @@ void cgana(int *len, entity ***free_methods);
 
 /** Free callee information.
  *
- *  Sets callee_info_state of the graph passed to none.
+ *  Sets callee_info_state of the graph passed to none.  Sets callee field
+ *  in all call nodes to NULL.  Else it happens that the field contains
+ *  pointers to other than firm arrays.
  */
 void free_callee_info(ir_graph *irg);
 
 /* Optimize the address expressions passed to call nodes.
  * Performs only the optimizations done by cgana. */
-/* @@@ move to irgopt ?! */
-/* @@@ not fully implemented as buggy !!!  */
 void opt_call_addrs(void);
 
 
diff --git a/ir/ana/trouts.c b/ir/ana/trouts.c
index 53bd324ce..d20cfd22b 100644
--- a/ir/ana/trouts.c
+++ b/ir/ana/trouts.c
@@ -18,9 +18,9 @@
 #include "irprog.h"
 #include "irgwalk.h"
 
-/**------------------------------------------------------------------*/
-/* We represent the fields in entities/types by hashmaps.            */
-/**------------------------------------------------------------------*/
+/*------------------------------------------------------------------*/
+/* We represent the fields in entities/types by hashmaps.           */
+/*------------------------------------------------------------------*/
 
 static pmap *entity_access_map = NULL;
 static pmap *entity_reference_map = NULL;
diff --git a/ir/ana/trouts.h b/ir/ana/trouts.h
index 4012e5c3f..7bdcf8d35 100644
--- a/ir/ana/trouts.h
+++ b/ir/ana/trouts.h
@@ -11,22 +11,22 @@
  */
 
 /**
-* @file trouts.h
-*
-* Trouts list all uses of types and entities.
-* Each type gets a list of all Alloc nodes allocating it.
-* Each entity gets two lists:
-*   - one containing all accesses (Load, (Call), Store),
-*   - and one containing all uses to get a reference (Sel, SymConst).
-*
-* @todo
-*   To list all uses of entities of a type, we also should list all
-*   static/automatic allocated entities in types.  The Alloc nodes
-*   represent only the dynamic allocated entities.
-*
-* @author Goetz Lindenmaier
-*
-*/
+ * @file trouts.h
+ *
+ * Trouts list all uses of types and entities.
+ * Each type gets a list of all Alloc nodes allocating it.
+ * Each entity gets two lists:
+ *   - one containing all accesses (Load, (Call), Store),
+ *   - and one containing all uses to get a reference (Sel, SymConst).
+ *
+ * @todo
+ *   To list all uses of entities of a type, we also should list all
+ *   static/automatic allocated entities in types.  The Alloc nodes
+ *   represent only the dynamic allocated entities.
+ *
+ * @author Goetz Lindenmaier
+ *
+ */
 
 # ifndef _TROUTS_H_
 # define _TROUTS_H_
-- 
2.20.1