encounter
/
SDL
mirror of https://github.com/encounter/SDL.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Changed some documentation comments in header files to be used by doxygen.

This commit is contained in:
Philipp Wiesemann 2013-08-18 11:08:52 +02:00
parent 7e3b7dbcb6
commit 8cf730554b
2 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/SDL_main.h
View File

@ -94,7 +94,7 @@ extern C_LINKAGE int SDL_main(int argc, char *argv[]);
extern "C" { extern "C" {
#endif #endif
/* /**
* This is called by the real SDL main function to let the rest of the * This is called by the real SDL main function to let the rest of the
* library know that initialization was done properly. * library know that initialization was done properly.
* *

10
include/SDL_thread.h
View File

@ -51,9 +51,10 @@ typedef unsigned long SDL_threadID;
/* Thread local storage ID, 0 is the invalid ID */ /* Thread local storage ID, 0 is the invalid ID */
typedef unsigned int SDL_TLSID; typedef unsigned int SDL_TLSID;
/* The SDL thread priority /**
* The SDL thread priority.
* *
* Note: On many systems you require special privileges to set high priority. * \note On many systems you require special privileges to set high priority.
*/ */
typedef enum { typedef enum {
SDL_THREAD_PRIORITY_LOW, SDL_THREAD_PRIORITY_LOW,
@ -61,8 +62,9 @@ typedef enum {
SDL_THREAD_PRIORITY_HIGH SDL_THREAD_PRIORITY_HIGH
} SDL_ThreadPriority; } SDL_ThreadPriority;
/* The function passed to SDL_CreateThread() /**
It is passed a void* user context parameter and returns an int. * The function passed to SDL_CreateThread().
* It is passed a void* user context parameter and returns an int.
*/ */
typedef int (SDLCALL * SDL_ThreadFunction) (void *data); typedef int (SDLCALL * SDL_ThreadFunction) (void *data);