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 10268 f97a7faf0b58
parent 10212 af95dd343a25
child 10269 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
--- a/include/SDL.h	Wed Jul 27 20:47:31 2016 +0200
+++ b/include/SDL.h	Wed Aug 03 22:30:31 2016 +0200
@@ -95,8 +95,8 @@
  *  This function initializes specific SDL subsystems
  *
  *  Subsystem initialization is ref-counted, you must call
- *  SDL_QuitSubSystem for each SDL_InitSubSystem to correctly
- *  shutdown a subsystem manually (or call SDL_Quit to force shutdown).
+ *  SDL_QuitSubSystem() for each SDL_InitSubSystem() to correctly
+ *  shutdown a subsystem manually (or call SDL_Quit() to force shutdown).
  *  If a subsystem is already loaded then this call will
  *  increase the ref-count and return.
  */
--- a/include/SDL_gamecontroller.h	Wed Jul 27 20:47:31 2016 +0200
+++ b/include/SDL_gamecontroller.h	Wed Aug 03 22:30:31 2016 +0200
@@ -93,7 +93,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:
+ *  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:
  *  guid,name,mappings
  *
  *  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.
@@ -136,14 +136,14 @@
 /**
  *  Get a mapping string for a GUID
  *
- *  \return the mapping string.  Must be freed with SDL_free.  Returns NULL if no mapping is available
+ *  \return the mapping string.  Must be freed with SDL_free().  Returns NULL if no mapping is available
  */
 extern DECLSPEC char * SDLCALL SDL_GameControllerMappingForGUID( SDL_JoystickGUID guid );
 
 /**
  *  Get a mapping string for an open GameController
  *
- *  \return the mapping string.  Must be freed with SDL_free.  Returns NULL if no mapping is available
+ *  \return the mapping string.  Must be freed with SDL_free().  Returns NULL if no mapping is available
  */
 extern DECLSPEC char * SDLCALL SDL_GameControllerMapping( SDL_GameController * gamecontroller );
 
--- a/include/SDL_hints.h	Wed Jul 27 20:47:31 2016 +0200
+++ b/include/SDL_hints.h	Wed Aug 03 22:30:31 2016 +0200
@@ -431,7 +431,7 @@
  *  privacy policy.
  *
  *  To setup a URL to an app's privacy policy, set SDL_HINT_WINRT_PRIVACY_POLICY_URL
- *  before calling any SDL_Init functions.  The contents of the hint should
+ *  before calling any SDL_Init() functions.  The contents of the hint should
  *  be a valid URL.  For example, "http://www.example.com".
  *
  *  The default value is "", which will prevent SDL from adding a privacy policy
@@ -461,7 +461,7 @@
  *  The contents of this hint should be encoded as a UTF8 string.
  *
  *  The default value is "Privacy Policy".  This hint should only be set during app
- *  initialization, preferably before any calls to SDL_Init.
+ *  initialization, preferably before any calls to SDL_Init().
  *
  *  For additional information on linking to a privacy policy, see the documentation for
  *  SDL_HINT_WINRT_PRIVACY_POLICY_URL.
--- a/include/SDL_joystick.h	Wed Jul 27 20:47:31 2016 +0200
+++ b/include/SDL_joystick.h	Wed Aug 03 22:30:31 2016 +0200
@@ -24,7 +24,7 @@
  *
  *  Include file for SDL joystick event handling
  *
- * The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks, with the exact joystick
+ * The term "device_index" identifies currently plugged in joystick devices between 0 and SDL_NumJoysticks(), with the exact joystick
  *   behind a device_index changing as joysticks are plugged and unplugged.
  *
  * The term "instance_id" is the current instantiation of a joystick device in the system, if the joystick is removed and then re-inserted
--- a/include/SDL_mouse.h	Wed Jul 27 20:47:31 2016 +0200
+++ b/include/SDL_mouse.h	Wed Aug 03 22:30:31 2016 +0200
@@ -41,7 +41,7 @@
 typedef struct SDL_Cursor SDL_Cursor;   /* Implementation dependent */
 
 /**
- * \brief Cursor types for SDL_CreateSystemCursor.
+ * \brief Cursor types for SDL_CreateSystemCursor().
  */
 typedef enum
 {