replaced variable args macros by functions to make it c89 compatible

[libfirm] / ir / ana / irloop.h

diff --git a/ir/ana/irloop.h b/ir/ana/irloop.h
index 6c8266d..2691d54 100644 (file)
--- a/ir/ana/irloop.h
+++ b/ir/ana/irloop.h
@@ -1,6 +1,14 @@
-/* Copyright (C) 2002 by Universitaet Karlsruhe
-* All rights reserved.
-*/
+/*
+ * Project:     libFIRM
+ * File name:   ir/ana/irloop_t.h
+ * Purpose:     Loop datastructure and access functions.
+ * Author:      Goetz Lindenmaier
+ * Modified by:
+ * Created:     7.2002
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 2002-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
 
 /**
 * @file irloop.h
@@ -13,8 +21,6 @@
 *  Constructs loops data structure: indicates loop nesting.
 */
 
-/* $Id$ */
-
 # ifndef _IRLOOP_H_
 # define _IRLOOP_H_
 
@@ -65,9 +71,9 @@ typedef struct ir_loop ir_loop;
 
 /* Loop elements are loop nodes and ir nodes */
 typedef union {
-    firm_kind *kind;    /* is either k_ir_node or k_ir_loop */
-    ir_node *node;      /* Pointer to a loop tree element */
-    ir_loop *son;       /* Pointer to a ir_graph element */
+    firm_kind *kind;    /**< is either k_ir_node or k_ir_loop */
+    ir_node *node;      /**< Pointer to an ir_node element */
+    ir_loop *son;       /**< Pointer to an ir_loop element */
 } loop_element;
 
 void     set_irg_loop(ir_graph *irg, ir_loop *l);
@@ -92,6 +98,8 @@ ir_node *get_loop_node (ir_loop *loop, int pos);
 
 /** Returns the number of elements contained in loop.  */
 int      get_loop_n_elements (ir_loop *loop);
+/** Returns a loop element.  A loop element can be interpreted as a
+    kind pointer, an ir_node* or an ir_loop*. */
 loop_element get_loop_element (ir_loop *loop, int pos);
 
 /*
@@ -102,10 +110,10 @@ loop_element get_loop_element (ir_loop *loop, int pos);
 void construct_backedges(ir_graph *irg);
 
 /** Constructs backedges for all irgs in interprocedural view.  All
-   loops in the graph will be marked as such, not only realizeable
-   loops and recursions in the program.  E.g., if the same funcion is
-   called twice, there is a loop between the first funcion return and
-   the second call.  */
+    loops in the graph will be marked as such, not only realizeable
+    loops and recursions in the program.  E.g., if the same funcion is
+    called twice, there is a loop between the first funcion return and
+    the second call.  */
 void construct_ip_backedges(void);
 
 #endif /* _IRLOOP_H_ */