updated header

more doxygen docu

[r13556]

ir/opt/funccall.c

@@ -17,14 +17,11 @@
  * PURPOSE.
  */
 
-/*
- * Project:     libFIRM
- * File name:   ir/opt/funccall.c
- * Purpose:     optimization of function calls
- * Author:      Michael Beck
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2006 Universitt Karlsruhe
+/**
+ * @file
+ * @brief   Optimization of function calls.
+ * @author  Michael Beck
+ * @version $Id$
  */
 #ifdef HAVE_CONFIG_H
 #include "config.h"

ir/opt/funccall.h

@@ -17,25 +17,14 @@
  * PURPOSE.
  */
 
-/*
- * Project:     libFIRM
- * File name:   ir/opt/ldstopt.h
- * Purpose:     optimization of real function calls
- * Author:      Michael Beck
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2005 Universität Karlsruhe
- */
-
 /**
- * @file funccall.h
- *
- * Optimization of real function calls.
- *
+ * @file
+ * @brief   Optimization of function calls.
  * @author  Michael Beck
+ * @version $Id$
  */
-#ifndef _FUNCCALL_H_
-#define _FUNCCALL_H_
+#ifndef FIRM_OPT_FUNCCALL_H
+#define FIRM_OPT_FUNCCALL_H
 
 /**
  * Optimize function calls by handling const functions.
@@ -59,12 +48,12 @@
  *
  * If callee information is valid, we also optimize polymorphic Calls.
  *
- * @param force_run  if set, an optimization run is startet even
+ * @param force_run  if non-zero, an optimization run is started even
  *                   if no const function graph was detected.
  *                   Else calls are only optimized if at least one
  *                   const function graph was detected.
  *
- * If the fontend created external entities with irg_const_function
+ * If the fontend created external entities with the irg_const_function
  * property set, the force_run parameter should be set, else
  * should be unset.
  *
@@ -72,4 +61,4 @@
  */
 void optimize_funccalls(int force_run);
 
-#endif /* _FUNCCALL_H_ */
+#endif /* FIRM_OPT_FUNCCALL_H */

ir/opt/gvn_pre.c

@@ -17,17 +17,17 @@
  * PURPOSE.
  */
 
-/*
- * Project:     libFIRM
- * File name:   ir/opt/gvn_pre.c
- * Purpose:     Global Value Numbering Partial Redundancy Elimination
+/**
+ * @file
+ * @brief   Global Value Numbering Partial Redundancy Elimination
  *          (VanDrunen Hosking 2004)
- * Author:      Michael Beck, Rubino Geiss
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2006 Universitt Karlsruhe
+ * @author  Michael Beck, Rubino Geiss
+ * @version $Id$
+ * @summary
+ *
+ * Currently completely broken because our stes so NOT preserve
+ * the topological sort!
  */
-
 #ifdef HAVE_CONFIG_H
 # include "config.h"
 #endif
@@ -975,7 +975,7 @@ static void eliminate_nodes(elim_pair *pairs)
 
 /*
  * Argh: Endless loops cause problems, because the
- * insert algorithm did not terminate. We get tranalated nodes that
+ * insert algorithm did not terminate. We get translated nodes that
  * references the origin. These nodes are translated again and again...
  *
  * The current fix is to use post-dominance. This simple ignores
@@ -989,6 +989,8 @@ void do_gvn_pre(ir_graph *irg)
   block_info *p;
   unsigned antic_iter, insert_iter;
 
+  assert(!"COMPLETELY BROKEN YET, DO NOT USE");
+
   /* register a debug mask */
   FIRM_DBG_REGISTER(dbg, "firm.opt.gvn_pre");
   firm_dbg_set_mask(dbg, SET_LEVEL_2);

ir/opt/gvn_pre.h

@@ -17,17 +17,15 @@
  * PURPOSE.
  */
 
-/*
- * Project:     libFIRM
- * File name:   ir/opt/gvn_pre.h
- * Purpose:     Global Value Numbering Partial Redundancy Elimination
- * Author:      Michael Beck, Rubino Geiss
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2006 Universität Karlsruhe
+/**
+ * @file
+ * @brief   Global Value Numbering Partial Redundancy Elimination
+ *          (VanDrunen Hosking 2004)
+ * @author  Michael Beck, Rubino Geiss
+ * @version $Id$
  */
-#ifndef __FIRM_OPT_GVN_PRE_H__
-#define __FIRM_OPT_GVN_PRE_H__
+#ifndef FIRM_OPT_GVN_PRE_H
+#define FIRM_OPT_GVN_PRE_H
 
 #include "firm_types.h"
 
@@ -37,7 +35,13 @@
  * Can be used to replace place_code() completely.
  *
  * Based on VanDrunen and Hosking 2004.
+ *
+ * @param irg  the graph
+ *
+ * @note
+ * Currently completely broken because the used sets do NOT
+ * preserve the topological sort of its elements.
  */
 void do_gvn_pre(ir_graph *irg);
 
-#endif /* __FIRM_OPT_GVN_PRE_H__ */
+#endif /* FIRM_OPT_GVN_PRE_H */

ir/opt/ldstopt.c

@@ -17,14 +17,11 @@
  * PURPOSE.
  */
 
-/*
- * Project:     libFIRM
- * File name:   ir/opt/ldstopt.c
- * Purpose:     load store optimizations
- * Author:      Michael Beck
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2007 Universitt Karlsruhe
+/**
+ * @file
+ * @brief   Load/Store optimizations.
+ * @author  Michael Beck
+ * @version $Id$
  */
 #ifdef HAVE_CONFIG_H
 # include "config.h"

ir/opt/ldstopt.h

@@ -17,27 +17,16 @@
  * PURPOSE.
  */
 
-/*
- * Project:     libFIRM
- * File name:   ir/opt/ldstopt.h
- * Purpose:     load/store optimizations
- * Author:      Michael Beck
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2007 Universität Karlsruhe
- */
-
 /**
- * @file ldstopt.h
- *
- * Load/Store optimization.
- *
+ * @file
+ * @brief   Load/Store optimizations.
  * @author  Michael Beck
+ * @version $Id$
  */
-#ifndef _LDSTOPT_H_
-#define _LDSTOPT_H_
+#ifndef FIRM_OPT_LDSTOPT_H
+#define FIRM_OPT_LDSTOPT_H
 
-#include "irgraph.h"
+#include "firm_types.h"
 
 /** Load/Store optimization.
  *
@@ -65,4 +54,4 @@
  */
 void optimize_load_store(ir_graph *irg);
 
-#endif /* _LDSTOPT_H_ */
+#endif /* FIRM_OPT_LDSTOPT_H */