Fix some doxygen warnings

This commit is contained in:
Bill Currie 2021-12-25 11:17:33 +09:00
parent 79b760b1d0
commit c87be87741
3 changed files with 20 additions and 3 deletions

View file

@ -92,7 +92,7 @@ void IMT_SetContextCbuf (int ctx, struct cbuf_s *cbuf);
Searches through all contexts for the named imt. The search is case
insensitive.
\param imt_name The name of the imt to find. Case insensitive.
\param name The name of the imt to find. Case insensitive.
\return The named imt, or null if not found.
*/
imt_t *IMT_FindIMT (const char *name) __attribute__ ((pure));

View file

@ -1637,7 +1637,7 @@ void *PR_Resources_Find (progs_t *pr, const char *name);
/** Retrieve a resource from the resource map using a handle.
\param map The resource map.
\param col The handle.
\param ind The handle.
\return A pointer to the resource, or NULL if the handle is
invalid.
*/

View file

@ -68,7 +68,7 @@ struct portable_samplepair_s {
float right; //!< right sample
};
/** communication structure between output drivers and renderer
/** Sound system state
*/
struct snd_s {
int speed; //!< sample rate
@ -280,16 +280,19 @@ sfx_t *SND_SFX_StreamOpen (sfx_t *sfx, void *file,
void SND_SFX_StreamClose (sfx_t *sfx);
/** Pre-load a sound into the cache.
\param snd sound system state
\param sample name of sound to precache
*/
sfx_t *SND_PrecacheSound (snd_t *snd, const char *sample);
/** Pre-load a sound.
\param snd sound system state
\param name name of sound to load
*/
sfx_t *SND_LoadSound (snd_t *snd, const char *name);
/** Initialize the sfx sub-subsystem
\param snd sound system state
*/
void SND_SFX_Init (snd_t *snd);
@ -314,10 +317,12 @@ extern channel_t snd_channels[MAX_CHANNELS]; //!< pool of available channels
extern int snd_total_channels; //!< number of active channels
/** Allocate a sound channel that can be used for playing sounds.
\param snd sound system state
*/
struct channel_s *SND_AllocChannel (snd_t *snd);
/** Stop a channel from playing.
\param snd sound system state
\param chan the channel to stop
*/
void SND_ChannelStop (snd_t *snd, channel_t *chan);
@ -329,6 +334,7 @@ void SND_ChannelStop (snd_t *snd, channel_t *chan);
void SND_FinishChannels (void);
/** Scan channels looking for stopped channels.
\param snd sound system state
\param wait if true, wait for the channels to be done. if false, force the
channels to be done. true is for threaded, false for
non-threaded.
@ -336,17 +342,20 @@ void SND_FinishChannels (void);
void SND_ScanChannels (snd_t *snd, int wait);
/** Disable ambient sounds.
\param snd sound system state
\todo not used, remove?
*/
void SND_AmbientOff (snd_t *snd);
/** Enable ambient sounds.
\param snd sound system state
\todo not used, remove?
*/
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
@ -359,14 +368,17 @@ void SND_SetListener (snd_t *snd, const vec3_t origin, const vec3_t v_forward,
const byte *ambient_sound_level);
/** Stop all sounds from playing.
\param snd sound system state
*/
void SND_StopAllSounds (snd_t *snd);
/** Initialize the channels sub-subsystem
\param snd sound system state
*/
void SND_Channels_Init (snd_t *snd);
/** Start a sound playing.
\param snd sound system state
\param entnum index of entity the sound is associated with.
\param entchannel 0-7
- 0 auto (never willingly overrides)
@ -383,6 +395,7 @@ void SND_StartSound (snd_t *snd, int entnum, int entchannel, sfx_t *sfx,
const vec3_t origin, float fvol, float attenuation);
/** Create a sound generated by the world.
\param snd sound system state
\param sfx sound to play
\param origin 3d coords of where the sound originates
\param vol absolute volume of the sound
@ -391,12 +404,14 @@ void SND_StartSound (snd_t *snd, int entnum, int entchannel, sfx_t *sfx,
void SND_StaticSound (snd_t *snd, sfx_t *sfx, const vec3_t origin, float vol,
float attenuation);
/** Stop an entity's sound.
\param snd sound system state
\param entnum index of entity the sound is associated with.
\param entchannel channel to silence
*/
void SND_StopSound (snd_t *snd, int entnum, int entchannel);
/** Start a sound local to the client view.
\param snd sound system state
\param s name of sound to play
*/
void SND_LocalSound (snd_t *snd, const char *s);
@ -409,11 +424,13 @@ void SND_LocalSound (snd_t *snd, const char *s);
///@{
/** Mix all active channels into the output buffer.
\param snd sound system state
\param endtime sample time until when to mix
*/
void SND_PaintChannels(snd_t *snd, unsigned int endtime);
/** Initialize the scale table for painting of 8 bit samples.
\param snd sound system state
*/
void SND_InitScaletable (snd_t *snd);