Fixed a few warnings that show up with -Wdocumentation and -Wdocumentation-unknown-command, patch contributed by Sylvain
authorSam Lantinga <slouken@libsdl.org>
Sun, 20 Nov 2016 21:26:56 -0800
changeset 10636e692b9291c81
parent 10635 49026b20848e
child 10637 5e3ac176d5a8
Fixed a few warnings that show up with -Wdocumentation and -Wdocumentation-unknown-command, patch contributed by Sylvain
include/SDL_assert.h
include/SDL_gamecontroller.h
include/SDL_hints.h
include/SDL_joystick.h
     1.1 --- a/include/SDL_assert.h	Sun Nov 20 21:24:09 2016 -0800
     1.2 +++ b/include/SDL_assert.h	Sun Nov 20 21:26:56 2016 -0800
     1.3 @@ -201,7 +201,7 @@
     1.4   *
     1.5   *  This callback is NOT reset to SDL's internal handler upon SDL_Quit()!
     1.6   *
     1.7 - *  \return SDL_AssertState value of how to handle the assertion failure.
     1.8 + *  Return SDL_AssertState value of how to handle the assertion failure.
     1.9   *
    1.10   *  \param handler Callback function, called when an assertion fails.
    1.11   *  \param userdata A pointer passed to the callback as-is.
    1.12 @@ -250,7 +250,7 @@
    1.13   *  <code>
    1.14   *  const SDL_AssertData *item = SDL_GetAssertionReport();
    1.15   *  while (item) {
    1.16 - *      printf("'%s', %s (%s:%d), triggered %u times, always ignore: %s.\n",
    1.17 + *      printf("'%s', %s (%s:%d), triggered %u times, always ignore: %s.\\n",
    1.18   *             item->condition, item->function, item->filename,
    1.19   *             item->linenum, item->trigger_count,
    1.20   *             item->always_ignore ? "yes" : "no");
     2.1 --- a/include/SDL_gamecontroller.h	Sun Nov 20 21:24:09 2016 -0800
     2.2 +++ b/include/SDL_gamecontroller.h	Sun Nov 20 21:26:56 2016 -0800
     2.3 @@ -51,7 +51,9 @@
     2.4   *  SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
     2.5   */
     2.6  
     2.7 -/* The gamecontroller structure used to identify an SDL game controller */
     2.8 +/**
     2.9 + * The gamecontroller structure used to identify an SDL game controller
    2.10 + */
    2.11  struct _SDL_GameController;
    2.12  typedef struct _SDL_GameController SDL_GameController;
    2.13  
     3.1 --- a/include/SDL_hints.h	Sun Nov 20 21:24:09 2016 -0800
     3.2 +++ b/include/SDL_hints.h	Sun Nov 20 21:26:56 2016 -0800
     3.3 @@ -781,13 +781,17 @@
     3.4  extern DECLSPEC SDL_bool SDLCALL SDL_GetHintBoolean(const char *name, SDL_bool default_value);
     3.5  
     3.6  /**
     3.7 + * \brief type definition of the hint callback function.
     3.8 + */
     3.9 +typedef void (*SDL_HintCallback)(void *userdata, const char *name, const char *oldValue, const char *newValue);
    3.10 +
    3.11 +/**
    3.12   *  \brief Add a function to watch a particular hint
    3.13   *
    3.14   *  \param name The hint to watch
    3.15   *  \param callback The function to call when the hint value changes
    3.16   *  \param userdata A pointer to pass to the callback function
    3.17   */
    3.18 -typedef void (*SDL_HintCallback)(void *userdata, const char *name, const char *oldValue, const char *newValue);
    3.19  extern DECLSPEC void SDLCALL SDL_AddHintCallback(const char *name,
    3.20                                                   SDL_HintCallback callback,
    3.21                                                   void *userdata);
     4.1 --- a/include/SDL_joystick.h	Sun Nov 20 21:24:09 2016 -0800
     4.2 +++ b/include/SDL_joystick.h	Sun Nov 20 21:26:56 2016 -0800
     4.3 @@ -60,7 +60,9 @@
     4.4   *  SDL_Init(): SDL_HINT_JOYSTICK_ALLOW_BACKGROUND_EVENTS
     4.5   */
     4.6  
     4.7 -/* The joystick structure used to identify an SDL joystick */
     4.8 +/**
     4.9 + * The joystick structure used to identify an SDL joystick
    4.10 + */
    4.11  struct _SDL_Joystick;
    4.12  typedef struct _SDL_Joystick SDL_Joystick;
    4.13