Commit a142727a authored by Matthias Braun's avatar Matthias Braun
Browse files

cleaned up doxygen comments

[r13522]
parent 277d3cd5
......@@ -18,12 +18,11 @@
*/
/**
* @file irarch.c
* @date 28.9.2004
* @author Sebastian Hack, Michael Beck
* @brief Machine dependent Firm optimizations.
*
* $Id$
* @file
* @brief Machine dependent Firm optimizations.
* @date 28.9.2004
* @author Sebastian Hack, Michael Beck
* @version $Id$
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
......
......@@ -18,16 +18,14 @@
*/
/**
* @file irarch.h
* @date 1.10.2004
* @file
* @brief Some machine dependent optimizations.
* @date 1.10.2004
* @author Sebastian Hack
* @brief Some machine dependent optimizations.
*
* $Id$
* @version $Id$
*/
#ifndef _FIRM_IR_IRARCH_H_
#define _FIRM_IR_IRARCH_H_
#ifndef FIRM_IR_IRARCH_H
#define FIRM_IR_IRARCH_H
#include "firm_types.h"
......@@ -155,4 +153,4 @@ ir_node *arch_dep_replace_mod_by_const(ir_node *irn);
*/
void arch_dep_replace_divmod_by_const(ir_node **div, ir_node **mod, ir_node *irn);
#endif /* _FIRM_IR_IRARCH_H_ */
#endif
......@@ -17,17 +17,12 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/irargs.c
* Purpose: Support for libcore IR object output.
* Author: Sebastian Hack
* Modified by:
* Created:
* CVS-ID: $Id$
* Copyright: (c) 1998-2005 Universitaet Karlsruhe
/**
* @file
* @brief Support for libcore IR object output.
* @author Sebastian Hack
* @version $Id$
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
......
......@@ -17,9 +17,13 @@
* PURPOSE.
*/
#ifndef _FIRM_IRARGS_H
#define _FIRM_IRARGS_H
/**
* @file
* @brief irargs private declarations
* @version $Id$
*/
#ifndef FIRM_IR_IRARGS_H
#define FIRM_IR_IRARGS_H
#include <libcore/lc_printf.h>
......
......@@ -18,13 +18,14 @@
*/
/**
* Some convenience macros for node bitmaps.
* @author Sebastian Hack
* @date 10.05.2006
* @file
* @brief Some convenience macros for node bitmaps.
* @author Sebastian Hack
* @date 10.05.2006
* @version $Id$
*/
#ifndef __FIRM_IRBITSET_H
#define __FIRM_IRBITSET_H
#ifndef FIRM_IR_IRBITSET_H
#define FIRM_IR_IRBITSET_H
#include "bitset.h"
......@@ -50,4 +51,4 @@
for(elm = bitset_next_set(bs, 0), irn = _bsfe_get_irn(irg, elm); elm != -1; elm = bitset_next_set(bs, elm + 1), irn = _bsfe_get_irn(irg, elm))
#endif /* __FIRM_IRBITSET_H */
#endif
......@@ -17,16 +17,13 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/ircgcons.c
* Purpose: Construction and removal of interprocedural representation
* (explicit interprocedural dependencies).
* Author: Hubert Schmid
* Modified by:
* Created: 09.06.2002
* CVS-ID: $Id$
* Copyright: (c) 2002-2003 Universitt Karlsruhe
/**
* @file
* @brief Construction and removal of interprocedural representation
* (explicit interprocedural dependencies).
* @author Hubert Schmid
* @date 09.06.2002
* @version $Id$
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
......
......@@ -17,19 +17,16 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/ircgcons.h
* Purpose: Construction and removal of interprocedural representation
* (explicit interprocedural dependencies).
* Author: Hubert Schmid
* Modified by:
* Created: 09.06.2002
* CVS-ID: $Id$
* Copyright: (c) 2002-2003 Universität Karlsruhe
/**
* @file
* @brief Construction and removal of interprocedural representation
* (explicit interprocedural dependencies).
* @author Hubert Schmid
* @date 09.06.2002
* @version $Id$
*/
#ifndef _FIRM_IR_ICGCONS_H_
#define _FIRM_IR_ICGCONS_H_
#ifndef FIRM_IR_IRCGCONS_H
#define FIRM_IR_IRCGCONS_H
#include "firm_types.h"
......@@ -67,4 +64,4 @@ void cg_construct(int arr_len, ir_entity *free_methods_arr[]);
the ir. Sets ip_view_no in irp. */
void cg_destruct(void);
#endif /* _FIRM_IR_ICGCONS_H_ */
#endif
......@@ -17,18 +17,15 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/ircgopt.c
* Purpose: Removal of unreachable methods.
* Author: Hubert Schmid
* Modified by:
* Created: 09.06.2002
* CVS-ID: $Id$
* Copyright: (c) 2002-2003 Universitt Karlsruhe
/**
* @file
* @brief Removal of unreachable methods.
* @author Hubert Schmid
* @date 09.06.2002
* @version $Id$
*/
/**
/*
* Entfernen von nicht erreichbaren (aufrufbaren) Methoden. Die Menge
* der nicht erreichbaren Methoden wird aus der Abschtzung der
* Aufrufrelation bestimmt.
......
......@@ -17,26 +17,20 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/ircgopt.h
* Purpose: Removal of unreachable methods.
* Author: Hubert Schmid
* Modified by:
* Created: 09.06.2002
* CVS-ID: $Id$
* Copyright: (c) 2002-2003 Universitt Karlsruhe
*/
/**
* @file irgopt.h
*
* Entfernen von nicht erreichbaren (aufrufbaren) Methoden. Die Menge
* der nicht erreichbaren Methoden wird aus der Abschtzung der
* Aufrufrelation bestimmt.
* @file
* @brief Removal of unreachable methods.
* @author Hubert Schmid
* @date 09.06.2002
* @version $Id$
* @summary
* (TODO: translate to english)
* Entfernen von nicht erreichbaren (aufrufbaren) Methoden. Die Menge
* der nicht erreichbaren Methoden wird aus der Abschtzung der
* Aufrufrelation bestimmt.
*/
#ifndef _FIRM_IR_ICGOPT_H_
#define _FIRM_IR_ICGOPT_H_
#ifndef FIRM_IR_ICGOPT_H
#define FIRM_IR_ICGOPT_H
#include "firm_types.h"
......@@ -49,4 +43,4 @@
* Frees all interprocedural loop information. */
void gc_irgs(int n_keep, ir_entity *keep_arr[]);
#endif /* _FIRM_IR_ICGOPT_H_ */
#endif
......@@ -17,18 +17,14 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/ircons.c
* Purpose: Various irnode constructors. Automatic construction
* of SSA representation.
* Author: Martin Trapp, Christian Schaefer
* Modified by: Goetz Lindenmaier, Boris Boesler, Michael Beck
* Created:
* CVS-ID: $Id$
* Copyright: (c) 1998-2007 Universitt Karlsruhe
/**
* @file
* @brief Various irnode constructors. Automatic construction of SSA
* representation.
* @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Boris Boesler
Michael Beck
* @version $Id$
*/
#ifdef HAVE_CONFIG_H
# include "config.h"
#endif
......
......@@ -17,20 +17,16 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/ircons.h
* Purpose: Various irnode constructors. Automatic construction
* of SSA representation.
* Author: Martin Trapp, Christian Schaefer
* Modified by: Goetz Lindenmaier, Boris Boesler, Michael Beck
* Created:
* CVS-ID: $Id$
* Copyright: (c) 1998-2006 Universität Karlsruhe
/**
* @file
* @brief Various irnode constructors. Automatic construction of SSA
* representation.
* @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Boris Boesler,
* Michael Beck
* @version $Id$
*/
/**
@todo
/**@todo
Ideas for improvement:
-# Handle construction of exceptions more comfortable:
Add new constructors that pass the exception region (or better the
......@@ -42,14 +38,12 @@
*/
/**
* @file ircons.h
* @file
*
* documentation no more supported since 2001
*
* ir node construction.
*
* @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier
*
* This file documents all datatypes and constructors needed to
* build a FIRM representation of a procedure. The constructors are
* also implemented in this file.
......@@ -1120,8 +1114,8 @@
* node.
*
*/
#ifndef _FIRM_IR_IRCONS_H_
#define _FIRM_IR_IRCONS_H_
#ifndef FIRM_IR_IRCONS_H
#define FIRM_IR_IRCONS_H
#include "firm_common.h"
#include "irnode.h"
......@@ -4352,4 +4346,4 @@ void irp_finalize_cons(void);
*/
typedef ir_node *uninitialized_local_variable_func_t(ir_graph *irg, ir_mode *mode, int pos);
#endif /* _FIRM_IR_IRCONS_H_ */
#endif
......@@ -17,22 +17,18 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/ircons_t.h
* Purpose: Various irnode constructors. Automatic construction
* of SSA representation.
* Author: Martin Trapp, Christian Schaefer
* Modified by: Michael Beck
* Created:
* CVS-ID: $Id$
* Copyright: (c) 1998-2003 Universitt Karlsruhe
/**
* @file
* @brief Various irnode constructors. Automatic construction
* of SSA representation. Private Header
* @author Martin Trapp, Christian Schaefer, Michael Beck
* @version $Id$
*/
#ifndef _IRCONS_T_H_
#define _IRCONS_T_H_
#ifndef FIRM_IR_IRCONS_T_H
#define FIRM_IR_IRCONS_T_H
#include "ircons.h"
# include "irgraph_t.h"
#include "irgraph_t.h"
/**
* Initializes the graph construction.
......@@ -60,4 +56,4 @@ _new_d_NoMem(void) {
#define new_d_Bad() _new_d_Bad()
#define new_d_NoMem() _new_d_NoMem()
#endif /* _IRCONS_T_H_ */
#endif
......@@ -17,15 +17,11 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/irdump.c
* Purpose: Write vcg representation of firm to file.
* Author: Martin Trapp, Christian Schaefer
* Modified by: Goetz Lindenmaier, Hubert Schmidt
* Created:
* CVS-ID: $Id$
* Copyright: (c) 1998-2006 Universit�t Karlsruhe
/**
* @file
* @brief Write vcg representation of firm to file.
* @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
* @version $Id$
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
......@@ -3021,9 +3017,9 @@ void dump_callgraph_loop_tree(const char *suffix) {
}
/*-----------------------------------------------------------------------------*/
/* Dumps the firm nodes in the loop tree to a graph along with the loop nodes. */
/*-----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
/* Dumps the firm nodes in the loop tree to a graph along with the loop nodes.*/
/*----------------------------------------------------------------------------*/
void collect_nodeloop(FILE *F, ir_loop *loop, eset *loopnodes) {
int i, son_number = 0, node_number = 0;
......
......@@ -17,36 +17,29 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/irdump.h
* Purpose: Write vcg representation of firm to file.
* Author: Martin Trapp, Christian Schaefer
* Modified by: Goetz Lindenmaier, Hubert Schmidt
* Created:
* CVS-ID: $Id$
* Copyright: (c) 1998-2003 Universität Karlsruhe
*/
/**
* @file irdump.h
*
* Dump routines for the ir graph and all type information.
* @file
* @brief Write vcg representation of firm to file.
* @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
* @version $Id$
* @summary
* Dump routines for the ir graph and all type information.
*
* @author Martin Trapp, Christian Schaefer
* The dump format of most functions is vcg. This is a text based graph
* representation. Some use the original format,
* but most generate an extended format that is only read by some special
* versions of xvcg or by the comercialized version now calles aiSee.
* A test version of aiSee is available at
* http://www.absint.de/aisee/download/index.htm.
*
* The dump format of most functions is vcg. This is a text based graph
* representation. Some use the original format,
* but most generate an extended format that is only read by some special
* versions of xvcg or by the comercialized version now calles aiSee.
* A test version of aiSee is available at
* http://www.absint.de/aisee/download/index.htm.
* We have developed an own advanced viewer called ycomp:
* http://www.info.uni-karlsruhe.de/software.php/id=6&lang=en
*
* Most routines use the name of the passed entity as the name of the
* file dumped to.
* Most routines use the name of the passed entity as the name of the
* file dumped to.
*/
#ifndef _FIRM_IR_IRDUMP_H_
#define _FIRM_IR_IRDUMP_H_
#ifndef FIRM_IR_IRDUMP_H
#define FIRM_IR_IRDUMP_H
#include "irnode.h"
#include "irgraph.h"
......@@ -702,4 +695,4 @@ void *dump_add_node_info_callback(dump_node_info_cb_t *cb, void *data);
*/
void dump_remv_node_info_callback(void *handle);
#endif /* _FIRM_IR_IRDUMP_H_ */
#endif
......@@ -17,10 +17,13 @@
* PURPOSE.
*/
#ifndef __IRDUMPT_T_H__
#define __IRDUMPT_T_H__
/**
* @file
* @brief Private header for irdump
* @version $Id$
*/
#ifndef FIRM_IR_IRDUMPT_T_H
#define FIRM_IR_IRDUMPT_T_H
#include "irdump.h"
......@@ -103,6 +106,4 @@ int dump_node_label(FILE *F, ir_node *n);
/** Writes vcg representation with title "PRINT_TYPEID(tp)" to file F. */
int dump_type_node(FILE *F, ir_type *tp);
#endif /* __IRDUMPT_T_H__ */
#endif
......@@ -17,15 +17,11 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/irdumptxt.c
* Purpose: Write vcg representation of firm to file.
* Author: Martin Trapp, Christian Schaefer
* Modified by: Goetz Lindenmaier, Hubert Schmidt
* Created:
* CVS-ID: $Id$
* Copyright: (c) 1998-2006 Universitt Karlsruhe
/**
* @file
* @brief Write vcg representation of firm to file.
* @author Martin Trapp, Christian Schaefer, Goetz Lindenmaier, Hubert Schmidt
* @version $Id$
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
......
......@@ -18,16 +18,13 @@
*/
/**
* @file iredgekinds.h
* @file
* @breif Declares different kind of edges between nodes
* @date 29.08.2006
* @author Sebastian Hack
*
* Copyright (C) 2006 Universitaet Karlsruhe
* Released under the GPL
*/
#ifndef _IREDGEKINDS_H
#define _IREDGEKINDS_H
#ifndef FIRM_IR_IREDGEKINDS_H
#define FIRM_IR_IREDGEKINDS_H
/** Supported Edge kinds. */
enum _ir_edge_kind_t {
......@@ -45,4 +42,4 @@ typedef enum _ir_edge_kind_t ir_edge_kind_t;
void edges_notify_edge_kind(ir_node *src, int pos, ir_node *tgt, ir_node *old_tgt, ir_edge_kind_t kind, ir_graph *irg);
#endif /* _IREDGEKINDS_H */
#endif
......@@ -17,23 +17,16 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/iredges.c
* Purpose: Always available outs.
* Author: Sebastian Hack
* Modified by: Michael Beck, Andreas Schoesser
* Created: 14.1.2005
* CVS-ID: $Id$
* Copyright: (c) 1998-2006 Universitt Karlsruhe
*/
/**
* Always available outs.
* @author Sebastian Hack
* @date 14.1.2005
* @file
* @brief Always available outs.
* @author Sebastian Hack, Michael Beck, Andreas Schoesser
* @date 14.1.2005
* @version $Id$
* @summary
* This are out-edges (also called def-use edges) that are dynamically
* updated as the graph changes.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
......@@ -52,10 +45,10 @@
#include "xmalloc.h"
/**
* A function that allows for setting an edge.
* This abstraction is necessary since different edge kind have
* different methods of setting edges.
*/
* A function that allows for setting an edge.
* This abstraction is necessary since different edge kind have
* different methods of setting edges.
*/
typedef void (set_edge_func_t)(ir_node *src, int pos, ir_node *tgt);
typedef int (get_edge_src_arity_func_t)(const ir_node *src);
......@@ -65,8 +58,8 @@ typedef int (get_edge_src_first_func_t)(const ir_node *src);
typedef ir_node *(get_edge_src_n_func_t)(const ir_node *src, int pos);
/**
* Additional data for an edge kind.
*/
* Additional data for an edge kind.
*/
typedef struct {
const char *name;
set_edge_func_t *set_edge;
......@@ -723,7 +716,7 @@ static void verify_edge_counter(ir_node *irn, void *env) {
ir_fprintf(stderr, "Edge Verifier: %+F reachable by %d node(s), but the list contains %d edge(s)\n",
irn, ref_cnt, list_cnt);
// Matze: buggy if a node has multiple ins pointing at irn
/* Matze: buggy if a node has multiple ins pointing at irn */
#if 0
list_for_each(pos, head) {
ir_edge_t *edge = list_entry(pos, ir_edge_t, list);
......
......@@ -17,24 +17,15 @@
* PURPOSE.
*/
/*
* Project: libFIRM
* File name: ir/ir/iredges.h
* Purpose: Public header for the automatically updating outs.
* Author: Sebastian Hack
* Created: 3.2.2005
* CVS-ID: $Id$
* Copyright: (c) 1998-2005 Universität Karlsruhe
*/
/**
* Public header for the automatically updating outs.
* @author Sebastian Hack
* @date 3.2.2005
* @file
* @brief Public header for the automatically updating outs.
* @author Sebastian Hack
* @date 3.2.2005
* @version $Id$
*/
#ifndef _FIRM_IR_EDGES_H
#define _FIRM_IR_EDGES_H
#ifndef FIRM_IR_IREDGES_H
#define FIRM_IR_IREDGES_H
#include "firm_types.h"
#include "iredgekinds.h"
......@@ -44,13 +35,6 @@
typedef struct _ir_edge_t ir_edge_t;
#endif
#if 0
#ifndef _IR_EDGE_KIND_TYPEDEF_
#define _IR_EDGE_KIND_TYPEDEF_
typedef enum _ir_edge_kind_t ir_edge_kind_t;
#endif /* _IR_EDGE_KIND_TYPEDEF_ */
#endif
/**
* Get the first edge pointing to some node.