Added brackets to function names in header comments so that doxygen links them.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Wed, 03 Aug 2016 22:30:31 +0200
changeset 10213f97a7faf0b58
parent 10212 af95dd343a25
child 10214 efff2efeb166
Added brackets to function names in header comments so that doxygen links them.
include/SDL.h
include/SDL_gamecontroller.h
include/SDL_hints.h
include/SDL_joystick.h
include/SDL_mouse.h
     1.1 --- a/include/SDL.h	Wed Jul 27 20:47:31 2016 +0200
     1.2 +++ b/include/SDL.h	Wed Aug 03 22:30:31 2016 +0200
     1.3 @@ -95,8 +95,8 @@
     1.4   *  This function initializes specific SDL subsystems
     1.5   *
     1.6   *  Subsystem initialization is ref-counted, you must call
     1.7 - *  SDL_QuitSubSystem for each SDL_InitSubSystem to correctly
     1.8 - *  shutdown a subsystem manually (or call SDL_Quit to force shutdown).
     1.9 + *  SDL_QuitSubSystem() for each SDL_InitSubSystem() to correctly
    1.10 + *  shutdown a subsystem manually (or call SDL_Quit() to force shutdown).
    1.11   *  If a subsystem is already loaded then this call will
    1.12   *  increase the ref-count and return.
    1.13   */
     2.1 --- a/include/SDL_gamecontroller.h	Wed Jul 27 20:47:31 2016 +0200
     2.2 +++ b/include/SDL_gamecontroller.h	Wed Aug 03 22:30:31 2016 +0200
     2.3 @@ -93,7 +93,7 @@
     2.4   *      }
     2.5   *  }
     2.6   *
     2.7 - *  Using the SDL_HINT_GAMECONTROLLERCONFIG hint or the SDL_GameControllerAddMapping you can add support for controllers SDL is unaware of or cause an existing controller to have a different binding. The format is:
     2.8 + *  Using the SDL_HINT_GAMECONTROLLERCONFIG hint or the SDL_GameControllerAddMapping() you can add support for controllers SDL is unaware of or cause an existing controller to have a different binding. The format is:
     2.9   *  guid,name,mappings
    2.10   *
    2.11   *  Where GUID is the string value from SDL_JoystickGetGUIDString(), name is the human readable string for the device and mappings are controller mappings to joystick ones.
    2.12 @@ -136,14 +136,14 @@
    2.13  /**
    2.14   *  Get a mapping string for a GUID
    2.15   *
    2.16 - *  \return the mapping string.  Must be freed with SDL_free.  Returns NULL if no mapping is available
    2.17 + *  \return the mapping string.  Must be freed with SDL_free().  Returns NULL if no mapping is available
    2.18   */
    2.19  extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForGUID( SDL_JoystickGUID guid );
    2.20  
    2.21  /**
    2.22   *  Get a mapping string for an open GameController
    2.23   *
    2.24 - *  \return the mapping string.  Must be freed with SDL_free.  Returns NULL if no mapping is available
    2.25 + *  \return the mapping string.  Must be freed with SDL_free().  Returns NULL if no mapping is available
    2.26   */
    2.27  extern DECLSPEC char * SDLCALL SDL_GameControllerMapping( SDL_GameController * gamecontroller );
    2.28  
     3.1 --- a/include/SDL_hints.h	Wed Jul 27 20:47:31 2016 +0200
     3.2 +++ b/include/SDL_hints.h	Wed Aug 03 22:30:31 2016 +0200
     3.3 @@ -431,7 +431,7 @@
     3.4   *  privacy policy.
     3.5   *
     3.6   *  To setup a URL to an app's privacy policy, set SDL_HINT_WINRT_PRIVACY_POLICY_URL
     3.7 - *  before calling any SDL_Init functions.  The contents of the hint should
     3.8 + *  before calling any SDL_Init() functions.  The contents of the hint should
     3.9   *  be a valid URL.  For example, "http://www.example.com".
    3.10   *
    3.11   *  The default value is "", which will prevent SDL from adding a privacy policy
    3.12 @@ -461,7 +461,7 @@
    3.13   *  The contents of this hint should be encoded as a UTF8 string.
    3.14   *
    3.15   *  The default value is "Privacy Policy".  This hint should only be set during app
    3.16 - *  initialization, preferably before any calls to SDL_Init.
    3.17 + *  initialization, preferably before any calls to SDL_Init().
    3.18   *
    3.19   *  For additional information on linking to a privacy policy, see the documentation for
    3.20   *  SDL_HINT_WINRT_PRIVACY_POLICY_URL.
     4.1 --- a/include/SDL_joystick.h	Wed Jul 27 20:47:31 2016 +0200
     4.2 +++ b/include/SDL_joystick.h	Wed Aug 03 22:30:31 2016 +0200
     4.3 @@ -24,7 +24,7 @@
     4.4   *
     4.5   *  Include file for SDL joystick event handling
     4.6   *
     4.7 - * The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks, with the exact joystick
     4.8 + * The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks(), with the exact joystick
     4.9   *   behind a device_index changing as joysticks are plugged and unplugged.
    4.10   *
    4.11   * The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
     5.1 --- a/include/SDL_mouse.h	Wed Jul 27 20:47:31 2016 +0200
     5.2 +++ b/include/SDL_mouse.h	Wed Aug 03 22:30:31 2016 +0200
     5.3 @@ -41,7 +41,7 @@
     5.4  typedef struct SDL_Cursor SDL_Cursor;   /* Implementation dependent */
     5.5  
     5.6  /**
     5.7 - * \brief Cursor types for SDL_CreateSystemCursor.
     5.8 + * \brief Cursor types for SDL_CreateSystemCursor().
     5.9   */
    5.10  typedef enum
    5.11  {