Changed some documentation comments in header files to be used by doxygen.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
diff --git a/include/SDL_main.h b/include/SDL_main.h
index bbb7e85..b7e4a10 100644
--- a/include/SDL_main.h
+++ b/include/SDL_main.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.
*
diff --git a/include/SDL_thread.h b/include/SDL_thread.h
index c878c3a..f248c3d 100644
--- a/include/SDL_thread.h
+++ b/include/SDL_thread.h
@@ -51,9 +51,10 @@ 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,
@@ -61,8 +62,9 @@ typedef enum {
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);