mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-11-17 15:51:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Remove Doxygen \brief tags.

Browse Source 
Doxygen and the wiki bridge don't need them; they'll both just use the first
line/sentence instead.

Fixes #8446.
This commit is contained in:
Ryan C. Gordon
2023-11-06 10:26:06 -05:00
parent c132295ad7
commit c53843a961
104 changed files with 669 additions and 667 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
include/SDL3/SDL_test_common.h
View File

@@ -22,7 +22,7 @@
/**
* \file SDL_test_common.h
*
* \brief Common functions of SDL test framework.
* Common functions of SDL test framework.
*
* This code is a part of the SDL test library, not the main SDL library.
*/
@@ -139,7 +139,7 @@ extern "C" {
/* Function prototypes */
/**
* \brief Parse command line parameters and create common state.
* Parse command line parameters and create common state.
*
* \param argv Array of command line parameters
* \param flags Flags indicating which subsystem to initialize (i.e. SDL_INIT_VIDEO | SDL_INIT_AUDIO)
@@ -149,14 +149,14 @@ extern "C" {
SDLTest_CommonState *SDLTest_CommonCreateState(char **argv, Uint32 flags);
/**
* \brief Free the common state object.
* Free the common state object.
*
* \param state The common state object to destroy
*/
void SDLTest_CommonDestroyState(SDLTest_CommonState *state);
/**
* \brief Process one common argument.
* Process one common argument.
*
* \param state The common state describing the test window to create.
* \param index The index of the argument to process in argv[].
@@ -167,7 +167,7 @@ int SDLTest_CommonArg(SDLTest_CommonState *state, int index);
/**
* \brief Logs command line usage info.
* Logs command line usage info.
*
* This logs the appropriate command line options for the subsystems in use
* plus other common options, and then any application-specific options.
@@ -181,7 +181,7 @@ int SDLTest_CommonArg(SDLTest_CommonState *state, int index);
void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const char **options);
/**
* \brief Open test window.
* Open test window.
*
* \param state The common state describing the test window to create.
*
@@ -190,7 +190,7 @@ void SDLTest_CommonLogUsage(SDLTest_CommonState *state, const char *argv0, const
SDL_bool SDLTest_CommonInit(SDLTest_CommonState *state);
/**
* \brief Easy argument handling when test app doesn't need any custom args.
* Easy argument handling when test app doesn't need any custom args.
*
* \param state The common state describing the test window to create.
* \param argc argc, as supplied to SDL_main
@@ -223,7 +223,7 @@ void SDLTest_CommonEvent(SDLTest_CommonState *state, SDL_Event *event, int *done
int SDLTest_CommonEventMainCallbacks(SDLTest_CommonState *state, const SDL_Event *event);
/**
* \brief Close test window.
* Close test window.
*
* \param state The common state used to create test window.
*
@@ -231,7 +231,7 @@ int SDLTest_CommonEventMainCallbacks(SDLTest_CommonState *state, const SDL_Event
void SDLTest_CommonQuit(SDLTest_CommonState *state);
/**
* \brief Draws various window information (position, size, etc.) to the renderer.
* Draws various window information (position, size, etc.) to the renderer.
*
* \param renderer The renderer to draw to.
* \param window The window whose information should be displayed.