More doxygen tweaks

This commit is contained in:
Bill Currie 2022-05-15 12:00:14 +09:00
parent 495e71193e
commit 0ba8d44654
2 changed files with 6 additions and 5 deletions

View file

@ -910,9 +910,9 @@ void PR_Undefined (progs_t *pr, const char *type, const char *name) __attribute_
/** \defgroup prda_return Return Values
\ingroup progs_data_access
These macros are used to access the value returned by an interpreted VM
function, and to return values from engine functions into progs space
(that is, builtins).
Typed return value access. These macros are used to access the value
returned by an interpreted VM function, and to return values from engine
functions into progs space (that is, builtins).
\warning No checking is performed against progs types; for example, if you
ask for an \c int from a function that returned a \c float, you're asking
for trouble.
@ -1730,7 +1730,7 @@ void PR_Resources_Clear (progs_t *pr);
registering the resource is a suitable name, and will
probably be unique.
\note During VM shutdown, \a clear is called (for all resources)
before \destroy is called.
before \a destroy is called.
*/
void PR_Resources_Register (progs_t *pr, const char *name, void *data,
void (*clear)(progs_t *, void *),

View file

@ -33,6 +33,7 @@
/** \defgroup segtext Segmented text files
\ingroup utils
Access named sections of a text file.
Based on The OpenGL Shader Wrangler:
https://prideout.net/blog/old/blog/index.html@p=11.html
@ -66,7 +67,7 @@ typedef struct segchunk_s {
Segments are stored sequentially in \a chunk_list are indexed by
identifying tag (if present) in \a tab.
Segments that have no identifying tag are not in \a tab, but can
be accessed by walking \a chunk_list its \a next field.
be accessed by walking \a chunk_list 's \a next field.
*/
typedef struct segtext_s {
struct segtext_s *next;