Skip to content
Permalink
Browse files

Changed some documentation comments in header files to be used by dox…

…ygen.
  • Loading branch information
philippwiesemann committed Aug 18, 2013
1 parent 7e3b7db commit 8cf730554b77ce4f91eee14f60c5fcfaaca4f845
Showing with 7 additions and 5 deletions.
  1. +1 −1 include/SDL_main.h
  2. +6 −4 include/SDL_thread.h
@@ -94,7 +94,7 @@ extern C_LINKAGE int SDL_main(int argc, char *argv[]);
extern "C" {
#endif

/*
/**
* This is called by the real SDL main function to let the rest of the
* library know that initialization was done properly.
*
@@ -51,18 +51,20 @@ typedef unsigned long SDL_threadID;
/* Thread local storage ID, 0 is the invalid ID */
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 {
SDL_THREAD_PRIORITY_LOW,
SDL_THREAD_PRIORITY_NORMAL,
SDL_THREAD_PRIORITY_HIGH
} 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);

0 comments on commit 8cf7305

Please sign in to comment.