From 7ca3ea53a92e084499a439f299d224efdaae6546 Mon Sep 17 00:00:00 2001 From: Michael Beck Date: Tue, 18 Oct 2005 15:23:32 +0000 Subject: [PATCH] doxygen docu fixed [r6730] --- ir/adt/list.h | 3 + ir/ir/ircons.h | 8 +- ir/ir/ircons_t.h | 5 +- ir/ir/irdump.h | 167 +++++++++++++++++++++++----------------- ir/ir/iropt_dbg.h | 2 +- ir/ir/irreflect.h | 4 +- ir/opt/loop_unrolling.c | 4 +- ir/opt/opt_confirms.c | 20 ++++- 8 files changed, 128 insertions(+), 85 deletions(-) diff --git a/ir/adt/list.h b/ir/adt/list.h index 201ed7feb..034f467ae 100644 --- a/ir/adt/list.h +++ b/ir/adt/list.h @@ -243,6 +243,7 @@ static INLINE void list_splice_init(struct list_head *list, /** * list_for_each_entry - iterate over list of given type + * @param type the type of the struct where the listhead is embedded in * @param pos the type * to use as a loop counter. * @param head the head for your list. * @param member the name of the list_struct within the struct. @@ -254,6 +255,7 @@ static INLINE void list_splice_init(struct list_head *list, /** * list_for_each_entry_reverse - iterate backwards over list of given type. + * @param type the type of the struct where the listhead is embedded in * @param pos the type * to use as a loop counter. * @param head the head for your list. * @param member the name of the list_struct within the struct. @@ -266,6 +268,7 @@ static INLINE void list_splice_init(struct list_head *list, /** * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry + * @param type the type of the struct where the listhead is embedded in * @param pos the type * to use as a loop counter. * @param n another type * to use as temporary storage * @param head the head for your list. diff --git a/ir/ir/ircons.h b/ir/ir/ircons.h index ed41f5d2d..1af3fd7fd 100644 --- a/ir/ir/ircons.h +++ b/ir/ir/ircons.h @@ -1821,7 +1821,7 @@ ir_node *new_rd_Mux (dbg_info *db, ir_graph *irg, ir_node *block, * @param *block The block the node belong to. * @param *store The current memory * @param *dst The ir_node that represents the destination address. - * @param *arg The ir_node that represents the source address. + * @param *src The ir_node that represents the source address. * @param *data_type The type of the copied data */ ir_node *new_rd_CopyB(dbg_info *db, ir_graph *irg, ir_node *block, @@ -2520,7 +2520,7 @@ ir_node *new_r_Mux (ir_graph *irg, ir_node *block, * @param *block The block the node belong to. * @param *store The current memory * @param *dst The ir_node that represents the destination address. - * @param *arg The ir_node that represents the source address. + * @param *src The ir_node that represents the source address. * @param *data_type The type of the copied data */ ir_node *new_r_CopyB(ir_graph *irg, ir_node *block, @@ -3234,7 +3234,7 @@ ir_node *new_d_Mux (dbg_info *db, ir_node *sel, * @param *db A pointer for debug information. * @param *store The current memory * @param *dst The ir_node that represents the destination address. - * @param *arg The ir_node that represents the source address. + * @param *src The ir_node that represents the source address. * @param *data_type The type of the copied data */ ir_node *new_d_CopyB(dbg_info *db, ir_node *store, ir_node *dst, ir_node *src, type *data_type); @@ -3846,7 +3846,7 @@ ir_node *new_Mux (ir_node *sel, ir_node *ir_false, ir_node *ir_true, ir_mode *m * * @param *store The current memory * @param *dst The ir_node that represents the destination address. - * @param *arg The ir_node that represents the source address. + * @param *src The ir_node that represents the source address. * @param *data_type The type of the copied data */ ir_node *new_CopyB(ir_node *store, ir_node *dst, ir_node *src, type *data_type); diff --git a/ir/ir/ircons_t.h b/ir/ir/ircons_t.h index 22c6ea368..212cffbdf 100644 --- a/ir/ir/ircons_t.h +++ b/ir/ir/ircons_t.h @@ -19,7 +19,10 @@ /** * Initializes the graph construction. * - * @param func @see uninitialized_local_variable_func_t + * @param func callback that is called if a uninitialized + * variable is detected + * + * @see uninitialized_local_variable_func_t */ void init_cons(uninitialized_local_variable_func_t *func); diff --git a/ir/ir/irdump.h b/ir/ir/irdump.h index 2e03d27f1..6721d91cb 100644 --- a/ir/ir/irdump.h +++ b/ir/ir/irdump.h @@ -82,7 +82,8 @@ DUMP_NODE_EDGE_FUNC get_dump_node_edge_hook(void); /** Dump a firm graph. * - * @param irg The firm graph to be dumped. + * @param irg The firm graph to be dumped. + * @param suffix A suffix for the file name. * * @return * A file containing the firm graph in vcg format. @@ -100,7 +101,8 @@ void dump_ir_graph (ir_graph *irg, const char *suffix); /** Dump a firm graph without explicit block nodes. * - * @param irg The firm graph to be dumped. + * @param irg The firm graph to be dumped. + * @param suffix A suffix for the file name. * * @return * A file containing the firm graph in vcg format. @@ -134,14 +136,17 @@ void dump_ir_block_graph (ir_graph *irg, const char *suffix); */ void dump_ir_extblock_graph (ir_graph *irg, const char *suffix); -/** Dumps all graphs in interprocedural view to a file named All_graphs.vcg. +/** Dumps all graphs in interprocedural view to a file named All_graphs.vcg. + * + * @param suffix A suffix for the file name. */ void dump_all_cg_block_graph(const char *suffix); /** Dumps a firm graph and all the type information needed for Calls, * Sels, ... in this graph. * - * @param irg The firm graph to be dumped with its type information. + * @param irg The firm graph to be dumped with its type information. + * @param suffix A suffix for the file name. * * @return * A file containing the firm graph and the type information of the firm graph in vcg format. @@ -157,7 +162,8 @@ void dump_ir_graph_w_types (ir_graph *irg, const char *suffix); /** Dumps a firm graph and all the type information needed for Calls, * Sels, ... in this graph. * - * @param irg The firm graph to be dumped with its type information. + * @param irg The firm graph to be dumped with its type information. + * @param suffix A suffix for the file name. * * @return * A file containing the firm graph and the type information of the firm graph in vcg format. @@ -171,21 +177,24 @@ void dump_ir_graph_w_types (ir_graph *irg, const char *suffix); */ void dump_ir_block_graph_w_types (ir_graph *irg, const char *suffix); -/** The type of a walker function that is called for each graph. +/** The type of a dump function that is called for each graph. * - * @param irg current visited graph + * @param irg current visited graph + * @param suffix A suffix for the file name. */ typedef void dump_graph_func(ir_graph *irg, const char *suffix); -/** A walker that calls a dumper for each graph. +/** + * A walker that calls a dumper for each graph. * - * @param dump_graph The dumper to be used for dumping. + * @param dump_graph The dumper to be used for dumping. + * @param suffix A suffix for the file name. * - * @return + * @return * Whatever the dumper creates. * - * Walks over all firm graphs and calls a dumper for each graph. - * The following dumpers can be passed as arguments: + * Walks over all firm graphs and calls a dumper for each graph. + * The following dumpers can be passed as arguments: * - dump_ir_graph() * - dump_ir_block_graph() * - dump_cfg() @@ -197,34 +206,37 @@ typedef void dump_graph_func(ir_graph *irg, const char *suffix); void dump_all_ir_graphs (dump_graph_func *dump_graph, const char *suffix); -/** Dump the control flow graph of a procedure. +/** + * Dump the control flow graph of a procedure. * - * @param irg The firm graph whose CFG shall be dumped. + * @param irg The firm graph whose CFG shall be dumped. + * @param suffix A suffix for the file name. * - * @return + * @return * A file containing the CFG in vcg format. * - * Dumps the control flow graph of a procedure in standard xvcg format. - * Dumps the graph to a file. The file name is constructed from the - * name of the entity describing the procedure (irg->entity) and the - * ending -cfg.vcg. Eventually overwrites existing files. + * Dumps the control flow graph of a procedure in standard xvcg format. + * Dumps the graph to a file. The file name is constructed from the + * name of the entity describing the procedure (irg->entity) and the + * ending -cfg.vcg. Eventually overwrites existing files. * * @see turn_off_edge_labels() */ void dump_cfg (ir_graph *irg, const char *suffix); -/** Dump a node and its predecessors forming a subgraph to a vcg file. +/** + * Dump a node and its predecessors forming a subgraph to a vcg file. * - * @param root The node serving as root for the subgraph. - * @param depth Dump nodes on paths starting at root with length depth. - * @param suffix A suffix for the file name. + * @param root The node serving as root for the subgraph. + * @param depth Dump nodes on paths starting at root with length depth. + * @param suffix A suffix for the file name. * - * Dumps the graph to a file. The file name is constructed from the - * name of the entity describing the procedure the passed node is - * in, suffix and the ending -subg_.vcg. nr is a unique number - * for each graph dumped. Eventually overwrites existing files. + * Dumps the graph to a file. The file name is constructed from the + * name of the entity describing the procedure the passed node is + * in, suffix and the ending -subg_.vcg. nr is a unique number + * for each graph dumped. Eventually overwrites existing files. * - * @return + * @return * A file containing the subgraph in vcg format. */ void dump_subgraph (ir_node *root, int depth, const char *suffix); @@ -238,6 +250,8 @@ void dump_subgraph (ir_node *root, int depth, const char *suffix); * * Dumps the callgraph to a file "Callgraph"".vcg". * + * @param suffix A suffix for the file name. + * * @see dump_callgraph_loop_tree(const char *suffix) */ void dump_callgraph(const char *suffix); @@ -247,11 +261,13 @@ void dump_callgraph(const char *suffix); /* **************************************************************************** */ /** - * Dumps all the type information needed for Calls, Sels, ... in this graph. - * Does not dump the graph! + * Dumps all the type information needed for Calls, Sels, ... in this graph. + * Does not dump the graph! * - * @param irg The firm graph whose type information is to be dumped. - * @return + * @param irg The firm graph whose type information is to be dumped. + * @param suffix A suffix for the file name. + * + * @return * A file containing the type information of the firm graph in vcg format. * * Dumps this graph to a file. The file name is constructed from the @@ -262,34 +278,39 @@ void dump_callgraph(const char *suffix); */ void dump_type_graph (ir_graph *irg, const char *suffix); -/** Dumps all type information. +/** + * Dumps all type information. * - * @return + * @param suffix A suffix for the file name. + * + * @return * A file containing all type information for the program in standard * vcg format. * - * Dumps all type information that is somehow reachable in standard vcg - * format. - * Dumps the graph to a file named All_types.vcg. + * Dumps all type information that is somehow reachable in standard vcg + * format. + * Dumps the graph to a file named All_types.vcg. * * @see turn_off_edge_labels() */ void dump_all_types (const char *suffix); -/** Dumps the class hierarchy with or without entities. +/** + * Dumps the class hierarchy with or without entities. * - * @param entities Flag whether to dump the entities. + * @param entities Flag whether to dump the entities. + * @param suffix A suffix for the file name. * - * @return + * @return * A file containing the class hierarchy tree for the program in standard * vcg format. * - * Does not dump the global type. - * Dumps a node for all classes and the sub/supertype relations. If - * entities is set to true also dumps the entities of classes, but without - * any additional information as the entities type. The overwrites relation - * is dumped along with the entities. - * Dumps to a file class_hierarchy.vcg + * Does not dump the global type. + * Dumps a node for all classes and the sub/supertype relations. If + * entities is set to true also dumps the entities of classes, but without + * any additional information as the entities type. The overwrites relation + * is dumped along with the entities. + * Dumps to a file class_hierarchy.vcg */ void dump_class_hierarchy (bool entities, const char *suffix); @@ -305,27 +326,27 @@ void dump_class_hierarchy (bool entities, const char *suffix); * * Implementing this dumper was stimulated by Florian Liekwegs similar dumper. * - * @arg irg Dump the loop tree for this graph. - * @arg suffix Suffix to filename. + * @param irg Dump the loop tree for this graph. + * @param suffix A suffix for the file name. */ void dump_loop_tree(ir_graph *irg, const char *suffix); /** Dumps the firm nodes in the sub-loop-tree of loop to a graph. * - * Dumps the loop nodes if dump_loop_information() is set. - * The name of the file is loop_.vcg. + * Dumps the loop nodes if dump_loop_information() is set. + * The name of the file is loop_.vcg. * - * @arg loop Dump the loop tree for this loop. - * @arg suffix Suffix to filename. + * @param l Dump the loop tree for this loop. + * @param suffix A suffix for the file name. */ void dump_loop (ir_loop *l, const char *suffix); /** Dumps the loop tree over the call graph. * - * See for yourself what you can use this for. - * The filename is "Callgraph_looptree.vcg". + * See for yourself what you can use this for. + * The filename is "Callgraph_looptree.vcg". * - * @arg suffix Suffix to filename. + * @param suffix A suffix for the file name. */ void dump_callgraph_loop_tree(const char *suffix); @@ -441,11 +462,13 @@ void dump_types_as_text(unsigned verbosity, const char *suffix); /** Dumps all global variables as text. * - * Dumps a text representation of the entities in the global type. + * @param suffix A suffix for the file name. * - * The file name is the program name (get_irp_name()), or 'TextTypes' - * if the program name is not set, appended by -globals.txt. - * For verbosity see the documentation of the verbosity flags above. + * Dumps a text representation of the entities in the global type. + * + * The file name is the program name (get_irp_name()), or 'TextTypes' + * if the program name is not set, appended by -globals.txt. + * For verbosity see the documentation of the verbosity flags above. */ void dump_globals_as_text(unsigned verbosity, const char *suffix); @@ -455,11 +478,11 @@ void dump_globals_as_text(unsigned verbosity, const char *suffix); /** Output a selected graph. * - * All graph dumpers check this name. If the name is != "" and - * not a prefix of the graph to be dumped, the dumper does not - * dump the graph. + * All graph dumpers check this name. If the name is != "" and + * not a prefix of the graph to be dumped, the dumper does not + * dump the graph. * - * @param name The prefix of the name (not the ld_name) of the method + * @param name The prefix of the name (not the ld_name) of the method * entity to be dumped. */ void only_dump_method_with_name(ident *name); @@ -471,20 +494,20 @@ ident *get_dump_file_filter_ident(void); * prefix of name. */ int is_filtered_dump_name(ident *name); -/** Sets the vcg flag "display_edge_labels" to no. +/** Sets the vcg flag "display_edge_labels" to no. * - * This is necessary as xvcg and aisee both fail to display graphs - * with self-edges if these edges have labels. + * This is necessary as xvcg and aisee both fail to display graphs + * with self-edges if these edges have labels. */ void turn_off_edge_labels(void); /** - * If set to true constants will be replicated for every use. In non - * blocked view edges from constant to block are skipped. Vcg then - * layouts the graphs more compact, this makes them better readable. - * The flag is automatically and temporarily set to false if other - * edges are dumped, as outs, loop, ... - * Default setting: false. + * If set to true constants will be replicated for every use. In non + * blocked view edges from constant to block are skipped. Vcg then + * layouts the graphs more compact, this makes them better readable. + * The flag is automatically and temporarily set to false if other + * edges are dumped, as outs, loop, ... + * Default setting: false. */ void dump_consts_local(bool b); diff --git a/ir/ir/iropt_dbg.h b/ir/ir/iropt_dbg.h index 3d0883a89..c567ea663 100644 --- a/ir/ir/iropt_dbg.h +++ b/ir/ir/iropt_dbg.h @@ -251,7 +251,7 @@ * Merge the debug info after a tuple optimization. * a Proj(Tuple) is replaced by the associated tuple value. * - * @param oldn the Proj node + * @param proj the Proj node * @param tuple the Tuple node * @param n the Proj(Tuple) value */ diff --git a/ir/ir/irreflect.h b/ir/ir/irreflect.h index c9b556ede..b598372b4 100644 --- a/ir/ir/irreflect.h +++ b/ir/ir/irreflect.h @@ -170,8 +170,8 @@ void rflct_new_opcode(opcode opc, const char *name, bool commutative); /** * Add a signature to the opcode. - * @param opc The opcode. - * @param args The signature. + * @param opc The opcode. + * @param sig The signature. * @return true, if the signature was added sucessfully, false if no * more signatures can be added to the opcode. */ diff --git a/ir/opt/loop_unrolling.c b/ir/opt/loop_unrolling.c index b7623c63f..94717291c 100644 --- a/ir/opt/loop_unrolling.c +++ b/ir/opt/loop_unrolling.c @@ -613,7 +613,7 @@ new_end_block(ir_node *end_block, ir_node *loop_head, set *l_n, set *loop_endblo * after loop block must have as well all copies of this node as predecessors. * * @param l_n Contains all nodes of the loop. - * @block block A block after the loop. + * @param block A block after the loop. * @param loop_in A node from the loop, that is predecessor of the end block. * @param unroll_factor An integer 2 <= unroll_factor <= 4. */ @@ -657,7 +657,7 @@ new_after_loop_block (set *l_n, ir_node* block, copies_t *loop_in, int unroll_fa * * @param l_n Contains all nodes of the loop. * @param loop_outs Contains nodes after the loop,that have as predecessor a node from the loop. - * @block node A node after the loop. + * @param node A node after the loop. * @param loop_in A node (Proj) from the loop, that is predecessor of *node. * @param unroll_factor An integer 2 <= unroll_factor <= 4. */ diff --git a/ir/opt/opt_confirms.c b/ir/opt/opt_confirms.c index f4e792707..8a9baa479 100644 --- a/ir/opt/opt_confirms.c +++ b/ir/opt/opt_confirms.c @@ -285,7 +285,7 @@ static interval_t *get_interval_from_tv(interval_t *iv, tarval *tv) * * @param iv an empty interval, will be filled * @param bound the bound value - * @param pnc the Confirm pnc relation + * @param pnc the Confirm compare relation * * @return the filled interval or NULL if no interval * can be created (happens only on floating point @@ -527,8 +527,10 @@ static int is_transitive(pn_Cmp pnc) { * Return the value of a Cmp if one or both predecessors * are Confirm nodes. * + * @param cmp the Cmp node * @param left the left operand of the Cmp * @param right the right operand of the Cmp + * @param pnc the compare relation */ tarval *computed_value_Cmp_Confirm(ir_node *cmp, ir_node *left, ir_node *right, pn_Cmp pnc) { @@ -696,6 +698,10 @@ tarval *computed_value_Cmp_Confirm(ir_node *cmp, ir_node *left, ir_node *right, #ifdef DEBUG_CONFIRM /** * For debugging. Prints an interval into a string. + * + * @param buf address of a string buffer + * @param len length of the string buffer + * @param iv the interval */ static int iv_snprintf(char *buf, size_t len, const interval_t *iv) { char smin[64], smax[64]; @@ -719,7 +725,11 @@ static int iv_snprintf(char *buf, size_t len, const interval_t *iv) { } /** - * For debugging. Prints an interval compare + * For debugging. Prints an interval compare. + * + * @param l_iv the left interval + * @param r_iv the right interval + * @param pnc the compare relation */ static void print_iv_cmp(const interval_t *l_iv, const interval_t *r_iv, pn_Cmp pnc) { @@ -732,7 +742,11 @@ static void print_iv_cmp(const interval_t *l_iv, const interval_t *r_iv, pn_Cmp } /** - * For debugging. call *compare_iv() and prints inputs and result + * For debugging. call *compare_iv() and prints inputs and result. + * + * @param l_iv the left interval + * @param r_iv the right interval + * @param pnc the compare relation */ static tarval *compare_iv_dbg(const interval_t *l_iv, const interval_t *r_iv, pn_Cmp pnc) { -- 2.20.1