Fixed comments in headers for doxygen output.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Sun, 04 Jun 2017 23:15:39 +0200
changeset 110659e8d300d50da
parent 11064 5491788d1015
child 11066 f39b145db3eb
Fixed comments in headers for doxygen output.
include/SDL_mouse.h
include/SDL_rwops.h
include/SDL_stdinc.h
include/SDL_syswm.h
include/SDL_video.h
     1.1 --- a/include/SDL_mouse.h	Sun Jun 04 23:15:27 2017 +0200
     1.2 +++ b/include/SDL_mouse.h	Sun Jun 04 23:15:39 2017 +0200
     1.3 @@ -38,7 +38,7 @@
     1.4  extern "C" {
     1.5  #endif
     1.6  
     1.7 -typedef struct SDL_Cursor SDL_Cursor;   /* Implementation dependent */
     1.8 +typedef struct SDL_Cursor SDL_Cursor;   /**< Implementation dependent */
     1.9  
    1.10  /**
    1.11   * \brief Cursor types for SDL_CreateSystemCursor().
     2.1 --- a/include/SDL_rwops.h	Sun Jun 04 23:15:27 2017 +0200
     2.2 +++ b/include/SDL_rwops.h	Sun Jun 04 23:15:39 2017 +0200
     2.3 @@ -39,12 +39,12 @@
     2.4  #endif
     2.5  
     2.6  /* RWops Types */
     2.7 -#define SDL_RWOPS_UNKNOWN   0U  /* Unknown stream type */
     2.8 -#define SDL_RWOPS_WINFILE   1U  /* Win32 file */
     2.9 -#define SDL_RWOPS_STDFILE   2U  /* Stdio file */
    2.10 -#define SDL_RWOPS_JNIFILE   3U  /* Android asset */
    2.11 -#define SDL_RWOPS_MEMORY    4U  /* Memory stream */
    2.12 -#define SDL_RWOPS_MEMORY_RO 5U  /* Read-Only memory stream */
    2.13 +#define SDL_RWOPS_UNKNOWN   0U  /**< Unknown stream type */
    2.14 +#define SDL_RWOPS_WINFILE   1U  /**< Win32 file */
    2.15 +#define SDL_RWOPS_STDFILE   2U  /**< Stdio file */
    2.16 +#define SDL_RWOPS_JNIFILE   3U  /**< Android asset */
    2.17 +#define SDL_RWOPS_MEMORY    4U  /**< Memory stream */
    2.18 +#define SDL_RWOPS_MEMORY_RO 5U  /**< Read-Only memory stream */
    2.19  
    2.20  /**
    2.21   * This is the read/write operation structure -- very basic.
     3.1 --- a/include/SDL_stdinc.h	Sun Jun 04 23:15:27 2017 +0200
     3.2 +++ b/include/SDL_stdinc.h	Sun Jun 04 23:15:39 2017 +0200
     3.3 @@ -445,7 +445,7 @@
     3.4  
     3.5  #ifndef HAVE_M_PI
     3.6  #ifndef M_PI
     3.7 -#define M_PI    3.14159265358979323846264338327950288   /* pi */
     3.8 +#define M_PI    3.14159265358979323846264338327950288   /**< pi */
     3.9  #endif
    3.10  #endif
    3.11  
     4.1 --- a/include/SDL_syswm.h	Sun Jun 04 23:15:27 2017 +0200
     4.2 +++ b/include/SDL_syswm.h	Sun Jun 04 23:15:39 2017 +0200
     4.3 @@ -229,9 +229,9 @@
     4.4          struct
     4.5          {
     4.6  #if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
     4.7 -            NSWindow __unsafe_unretained *window; /* The Cocoa window */
     4.8 +            NSWindow __unsafe_unretained *window; /**< The Cocoa window */
     4.9  #else
    4.10 -            NSWindow *window;                     /* The Cocoa window */
    4.11 +            NSWindow *window;                     /**< The Cocoa window */
    4.12  #endif
    4.13          } cocoa;
    4.14  #endif
    4.15 @@ -239,13 +239,13 @@
    4.16          struct
    4.17          {
    4.18  #if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
    4.19 -            UIWindow __unsafe_unretained *window; /* The UIKit window */
    4.20 +            UIWindow __unsafe_unretained *window; /**< The UIKit window */
    4.21  #else
    4.22 -            UIWindow *window;                     /* The UIKit window */
    4.23 +            UIWindow *window;                     /**< The UIKit window */
    4.24  #endif
    4.25 -            GLuint framebuffer; /* The GL view's Framebuffer Object. It must be bound when rendering to the screen using GL. */
    4.26 -            GLuint colorbuffer; /* The GL view's color Renderbuffer Object. It must be bound when SDL_GL_SwapWindow is called. */
    4.27 -            GLuint resolveFramebuffer; /* The Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used. */
    4.28 +            GLuint framebuffer; /**< The GL view's Framebuffer Object. It must be bound when rendering to the screen using GL. */
    4.29 +            GLuint colorbuffer; /**< The GL view's color Renderbuffer Object. It must be bound when SDL_GL_SwapWindow is called. */
    4.30 +            GLuint resolveFramebuffer; /**< The Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used. */
    4.31          } uikit;
    4.32  #endif
    4.33  #if defined(SDL_VIDEO_DRIVER_WAYLAND)
     5.1 --- a/include/SDL_video.h	Sun Jun 04 23:15:27 2017 +0200
     5.2 +++ b/include/SDL_video.h	Sun Jun 04 23:15:39 2017 +0200
     5.3 @@ -208,7 +208,7 @@
     5.4  {
     5.5      SDL_GL_CONTEXT_PROFILE_CORE           = 0x0001,
     5.6      SDL_GL_CONTEXT_PROFILE_COMPATIBILITY  = 0x0002,
     5.7 -    SDL_GL_CONTEXT_PROFILE_ES             = 0x0004 /* GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
     5.8 +    SDL_GL_CONTEXT_PROFILE_ES             = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
     5.9  } SDL_GLprofile;
    5.10  
    5.11  typedef enum