qf/quakeforge
0
0
Fork 0
mirror of https://git.code.sf.net/p/quake/quakeforge synced 2025-02-17 01:11:45 +00:00
Code Issues Projects Releases Packages Wiki Activity

clean up a bunch of doxygen warnings

Browse source
This commit is contained in:
Bill Currie 2010-08-11 23:41:30 +00:00 committed by Jeff Teunissen
parent c0a8c6c695
commit f04bc64ef1
2 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/quakeforge.dox.in
View file

@ -846,7 +846,7 @@ SEARCH_INCLUDES = YES
# contain include files that are not input files but should be processed by
# the preprocessor.
INCLUDE_PATH =
INCLUDE_PATH = @top_srcdir@/include
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the

15
tools/qfcc/include/obj_file.h
View file

@ -93,6 +93,7 @@ typedef struct qfo_def_s {
string_t file; ///< source file name
pr_int_t line; ///< source line number
} qfo_def_t;
///@}
/** \defgroup qfcc_qfo_QFOD QFOD flags
\ingroup qfcc_qfo
@ -149,6 +150,10 @@ typedef struct qfo_def_s {
#define QFOD_NOSAVE (1u<<7)
///@}
/** \ingroup qfcc_qfo
*/
///@{
/** Representation of a function in the object file.
*/
typedef struct qfo_func_s {
@ -185,7 +190,7 @@ typedef struct qfo_func_s {
pr_int_t num_local_defs; ///< Number of local def records.
///@}
pr_int_t line_info; ///< Index to first ::qfo_line_t line record.
pr_int_t line_info; ///< Index to first ::pr_lineno_t line record.
///< Zero if there are no records.
/** \name Function parameters.
@ -263,6 +268,7 @@ typedef struct qfo_s {
int types_size;
int entity_fields;
} qfo_t;
///@}
/** \defgroup qfcc_qfo_data_access QFO Data Acess
\ingroup qfcc_qfo
@ -375,6 +381,7 @@ typedef struct qfo_s {
\par QC type:
\c void []
\param q pointer to ::qfo_t struct
\param t C type of the structure
\param o offset into object file data space
\return pointer_t lvalue
@ -397,6 +404,10 @@ typedef struct qfo_s {
///@}
/** \ingroup qfcc_qfo
*/
///@{
struct pr_info_s;
/** Convert ::pr_info_t structure to ::qfo_t.
@ -453,7 +464,7 @@ void qfo_add_data (qfo_t *qfo, pr_type_t *data, int data_size);
/** Add a block of far data to a ::qfo_t struct.
\param qfo ::qfo_t struct to add to
\param far_data pointer to beginning of far data block
\param data_size number of data words in the far data block
\param far_data_size number of data words in the far data block
*/
void qfo_add_far_data (qfo_t *qfo, pr_type_t *far_data, int far_data_size);