fix documentation warnings

[libfirm] / include / libfirm / dbginfo.h

diff --git a/include/libfirm/dbginfo.h b/include/libfirm/dbginfo.h
index 6f60c6b..9778aea 100644 (file)
--- a/include/libfirm/dbginfo.h
+++ b/include/libfirm/dbginfo.h
@@ -144,13 +144,21 @@ 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);
 
+/** A sourcecode location */
+typedef struct src_loc_t {
+       char const *file;    /**< the name of the source (usually a file) */
+       unsigned    line;    /**< line number (starting at 1; 0 if unknown) */
+       unsigned    column;  /**< column number (starting at 1; 0 if unknown) */
+} src_loc_t;
+
 /**
  * The type of the debug info retriever function.
- *  When given a dbg_info returns the name (usually the filename) of the
- *  compilation unit defining it. @p line is set to the line number of the
- *  definition.
+ *  When given a dbg_info returns the name (usually the filename), line number
+ *  and column number of the definition.
+ *  Any part of the returned information may be NULL/0, which means it is not
+ *  available.
  */
-typedef const char *(*retrieve_dbg_func)(const dbg_info *dbg, unsigned *line);
+typedef src_loc_t (*retrieve_dbg_func)(dbg_info const *dbg);
 
 /**
  * Sets a debug info retriever.
@@ -168,14 +176,14 @@ 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);
 
 /**
  * Retrieve the debug info.
  */
-FIRM_API const char *ir_retrieve_dbg_info(const dbg_info *dbg, unsigned *line);
+FIRM_API src_loc_t ir_retrieve_dbg_info(dbg_info const *dbg);
 
 /**
  * Retrieve type debug info