mirror of https://github.com/encounter/SDL.git
Fixed comments in headers for doxygen output.
This commit is contained in:
parent
52b7d0eb23
commit
cbcc256fd2
|
@ -38,7 +38,7 @@
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
typedef struct SDL_Cursor SDL_Cursor; /* Implementation dependent */
|
typedef struct SDL_Cursor SDL_Cursor; /**< Implementation dependent */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* \brief Cursor types for SDL_CreateSystemCursor().
|
* \brief Cursor types for SDL_CreateSystemCursor().
|
||||||
|
|
|
@ -39,12 +39,12 @@ extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
/* RWops Types */
|
/* RWops Types */
|
||||||
#define SDL_RWOPS_UNKNOWN 0U /* Unknown stream type */
|
#define SDL_RWOPS_UNKNOWN 0U /**< Unknown stream type */
|
||||||
#define SDL_RWOPS_WINFILE 1U /* Win32 file */
|
#define SDL_RWOPS_WINFILE 1U /**< Win32 file */
|
||||||
#define SDL_RWOPS_STDFILE 2U /* Stdio file */
|
#define SDL_RWOPS_STDFILE 2U /**< Stdio file */
|
||||||
#define SDL_RWOPS_JNIFILE 3U /* Android asset */
|
#define SDL_RWOPS_JNIFILE 3U /**< Android asset */
|
||||||
#define SDL_RWOPS_MEMORY 4U /* Memory stream */
|
#define SDL_RWOPS_MEMORY 4U /**< Memory stream */
|
||||||
#define SDL_RWOPS_MEMORY_RO 5U /* Read-Only memory stream */
|
#define SDL_RWOPS_MEMORY_RO 5U /**< Read-Only memory stream */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This is the read/write operation structure -- very basic.
|
* This is the read/write operation structure -- very basic.
|
||||||
|
|
|
@ -445,7 +445,7 @@ extern DECLSPEC int SDLCALL SDL_vsnprintf(SDL_OUT_Z_CAP(maxlen) char *text, size
|
||||||
|
|
||||||
#ifndef HAVE_M_PI
|
#ifndef HAVE_M_PI
|
||||||
#ifndef M_PI
|
#ifndef M_PI
|
||||||
#define M_PI 3.14159265358979323846264338327950288 /* pi */
|
#define M_PI 3.14159265358979323846264338327950288 /**< pi */
|
||||||
#endif
|
#endif
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
|
@ -229,9 +229,9 @@ struct SDL_SysWMinfo
|
||||||
struct
|
struct
|
||||||
{
|
{
|
||||||
#if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
|
#if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
|
||||||
NSWindow __unsafe_unretained *window; /* The Cocoa window */
|
NSWindow __unsafe_unretained *window; /**< The Cocoa window */
|
||||||
#else
|
#else
|
||||||
NSWindow *window; /* The Cocoa window */
|
NSWindow *window; /**< The Cocoa window */
|
||||||
#endif
|
#endif
|
||||||
} cocoa;
|
} cocoa;
|
||||||
#endif
|
#endif
|
||||||
|
@ -239,13 +239,13 @@ struct SDL_SysWMinfo
|
||||||
struct
|
struct
|
||||||
{
|
{
|
||||||
#if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
|
#if defined(__OBJC__) && defined(__has_feature) && __has_feature(objc_arc)
|
||||||
UIWindow __unsafe_unretained *window; /* The UIKit window */
|
UIWindow __unsafe_unretained *window; /**< The UIKit window */
|
||||||
#else
|
#else
|
||||||
UIWindow *window; /* The UIKit window */
|
UIWindow *window; /**< The UIKit window */
|
||||||
#endif
|
#endif
|
||||||
GLuint framebuffer; /* The GL view's Framebuffer Object. It must be bound when rendering to the screen using GL. */
|
GLuint framebuffer; /**< The GL view's Framebuffer Object. It must be bound when rendering to the screen using GL. */
|
||||||
GLuint colorbuffer; /* The GL view's color Renderbuffer Object. It must be bound when SDL_GL_SwapWindow is called. */
|
GLuint colorbuffer; /**< The GL view's color Renderbuffer Object. It must be bound when SDL_GL_SwapWindow is called. */
|
||||||
GLuint resolveFramebuffer; /* The Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used. */
|
GLuint resolveFramebuffer; /**< The Framebuffer Object which holds the resolve color Renderbuffer, when MSAA is used. */
|
||||||
} uikit;
|
} uikit;
|
||||||
#endif
|
#endif
|
||||||
#if defined(SDL_VIDEO_DRIVER_WAYLAND)
|
#if defined(SDL_VIDEO_DRIVER_WAYLAND)
|
||||||
|
|
|
@ -208,7 +208,7 @@ typedef enum
|
||||||
{
|
{
|
||||||
SDL_GL_CONTEXT_PROFILE_CORE = 0x0001,
|
SDL_GL_CONTEXT_PROFILE_CORE = 0x0001,
|
||||||
SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002,
|
SDL_GL_CONTEXT_PROFILE_COMPATIBILITY = 0x0002,
|
||||||
SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /* GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
|
SDL_GL_CONTEXT_PROFILE_ES = 0x0004 /**< GLX_CONTEXT_ES2_PROFILE_BIT_EXT */
|
||||||
} SDL_GLprofile;
|
} SDL_GLprofile;
|
||||||
|
|
||||||
typedef enum
|
typedef enum
|
||||||
|
|
Loading…
Reference in New Issue