[dox] Fix up some doxygen issues

I found a few doxygen related patches in my git stash and while testing
them, found a few doc issues.
This commit is contained in:
Bill Currie 2022-04-12 21:01:41 +09:00
parent 063c0797d6
commit 32a395a8d5
9 changed files with 33 additions and 10 deletions

View file

@ -2133,7 +2133,8 @@ SEARCH_INCLUDES = YES
INCLUDE_PATH = @TOPSRC@/include \
@TOPSRC@/nq/include \
@TOPSRC@/qw/include \
@TOPSRC@/qtv/include
@TOPSRC@/qtv/include \
@TOPSRC@
# 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
@ -2152,6 +2153,7 @@ INCLUDE_FILE_PATTERNS = *.h
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = "__attribute__(x)=" \
IN_DOXYGEN=1 \
VISIBLE=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this

View file

@ -28,6 +28,9 @@
#ifndef __QF_input_h
#define __QF_input_h
/** \defgroup input Input Sub-system */
///@{
typedef struct in_axisinfo_s {
int deviceid;
int axis;
@ -135,4 +138,6 @@ extern struct cvar_s *lookstrafe;
#endif
///@}
#endif//__QF_input_h

View file

@ -34,6 +34,11 @@
#include "QF/mathlib.h"
#endif
/** \defgroup input_bindings Input Bindings
\ingroup input
*/
///@{
/*** Recipe for converting an axis to a floating point value.
Absolute axes are converted to the 0..1 range for unbalanced axes, and
@ -366,4 +371,6 @@ void IN_Binding_LoadConfig (struct plitem_s *config);
#endif
///@}
#endif//__QF_input_binding_h

View file

@ -33,6 +33,11 @@
#include "QF/qtypes.h"
/** \defgroup input_events Input Events
\ingroup input
*/
///@{
typedef struct {
int xpos, ypos;
int xlen, ylen;
@ -122,4 +127,6 @@ void IE_Remove_Handler (int handle);
void IE_Set_Focus (int handle);
int IE_Get_Focus (void) __attribute__ ((pure));
///@}
#endif//__QF_in_event_h

View file

@ -29,6 +29,11 @@
#ifndef __QF_input_imt_h
#define __QF_input_imt_h
/** \defgroup input_imt Input Mapping Tables
\ingroup input
*/
///@{
#ifndef __QFCC__
#include "QF/darray.h"
@ -134,4 +139,6 @@ void IMT_LoadConfig (struct plitem_s *config);
#endif
///@}
#endif//__QF_input_imt_h

View file

@ -34,8 +34,6 @@
# include "QF/quakeio.h"
#endif
/** \defgroup input Input Sub-system */
/** \defgroup input_keybinding Key Binding Sub-system
\ingroup input
*/

View file

@ -431,7 +431,9 @@ typedef enum {
#define OP_BREAK 0x8000
typedef enum {
#ifndef IN_DOXYGEN
#include "QF/progs/pr_opcode.hinc"
#endif
} pr_opcode_e;
// Used for both branch and comparison, with jump and call being ignored for

View file

@ -133,9 +133,6 @@ void S_StopAllSounds(void);
render some sound.
\param ear Transform for the position and orientation of the stereo
sound pickup.
\param v_forward 3d vector of the client's facing direction
\param v_right 3d vector of the client's rightward direction
\param v_up 3d vector of the client's upward direction
\param ambient_sound_level NUM_AMBIENTS bytes indicating current ambient
sound levels
*/

View file

@ -353,10 +353,8 @@ void SND_AmbientOn (snd_t *snd);
/** Update the sound engine with the client's position and orientation and
render some sound.
\param snd sound system state
\param origin 3d coords of the client
\param v_forward 3d vector of the client's facing direction
\param v_right 3d vector of the client's rightward direction
\param v_up 3d vector of the client's upward direction
\param ear Transform for the position and orientation of the stereo
sound pickup.
\param ambient_sound_level Pointer to 4 bytes indicating the levels at
which to play the ambient sounds.
*/