X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=include%2Flibfirm%2Fdbginfo.h;h=785fb6e9c42a263e443ec07b45c10444a3350e0b;hb=5474a1c188c9d59eea2c915515980cd9cbab58d8;hp=479ae8f4cb1fe14adc7668d703d9bef5d386523d;hpb=74d5a9023b48f346eead323a74e28297659e34b7;p=libfirm diff --git a/include/libfirm/dbginfo.h b/include/libfirm/dbginfo.h index 479ae8f4c..785fb6e9c 100644 --- a/include/libfirm/dbginfo.h +++ b/include/libfirm/dbginfo.h @@ -22,15 +22,6 @@ * @brief Implements the Firm interface to debug information. * @author Goetz Lindenmaier, Michael Beck * @date 2001 - * @version $Id$ - * @brief - * Firm requires a debugging module fulfilling this interface, else no - * debugging information is passed to the backend. - * The interface requires a datatype representing the debugging - * information. Firm supports administrating a reference to the debug - * information in every Firm node. Further Firm optimizations call - * routines to propagate debug information from old nodes to new nodes - * if the optimization replaces the old ones by the new ones. */ #ifndef FIRM_DEBUG_DBGINFO_H #define FIRM_DEBUG_DBGINFO_H @@ -41,8 +32,14 @@ #include "begin.h" /** - * @defgroup debug The Firm interface to debugging support. - * + * @defgroup dbg_info Source References + * Firm requires a debugging module fulfilling this interface, else no + * debugging information is passed to the backend. + * The interface requires a datatype representing the debugging + * information. Firm supports administrating a reference to the debug + * information in every Firm node. Further Firm optimizations call + * routines to propagate debug information from old nodes to new nodes + * if the optimization replaces the old ones by the new ones. * @{ */ @@ -81,7 +78,7 @@ typedef enum { dbg_read_a_const, /**< A Firm subgraph was replaced because of a read a constant optimization. */ dbg_rem_poly_call, /**< Remove polymorphic call. */ - dbg_dead_code, /**< Removing unreachable code, I.e. blocks that are never executed. */ + dbg_dead_code, /**< Removing unreachable code, i.e. blocks that are never executed. */ dbg_opt_confirm, /**< A Firm subgraph was replace because of a Confirmation. */ dbg_gvn_pre, /**< A Firm node was replace because of the GVN-PRE algorithm. */ dbg_combo, /**< A Firm node was replace because of the combo algorithm. */ @@ -147,8 +144,6 @@ typedef void merge_sets_func(ir_node **new_node_array, int new_num_entries, ir_n FIRM_API void dbg_init(merge_pair_func *dbg_info_merge_pair, merge_sets_func *dbg_info_merge_sets); -/** @} */ - /** * The type of the debug info retriever function. * When given a dbg_info returns the name (usually the filename) of the @@ -173,7 +168,7 @@ typedef void (*retrieve_type_dbg_func)(char *buffer, size_t buffer_size, const type_dbg_info *tdbgi); /** - * Set global print_type_dbg_info function in firm + * Sets global print_type_dbg_info function in firm */ FIRM_API void ir_set_type_debug_retrieve(retrieve_type_dbg_func func); @@ -188,6 +183,8 @@ FIRM_API const char *ir_retrieve_dbg_info(const dbg_info *dbg, unsigned *line); FIRM_API void ir_retrieve_type_dbg_info(char *buffer, size_t buffer_size, const type_dbg_info *tdbgi); +/** @} */ + #include "end.h" #endif