Changed some documentation comments in header files to be used by doxygen.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Sun, 18 Aug 2013 11:08:52 +0200
changeset 7653 9a0e274b8aa7
parent 7652 cf8970659129
child 7654 e8cbbb272243
Changed some documentation comments in header files to be used by doxygen.
include/SDL_main.h
include/SDL_thread.h
--- a/include/SDL_main.h	Sat Aug 17 20:46:34 2013 -0400
+++ b/include/SDL_main.h	Sun Aug 18 11:08:52 2013 +0200
@@ -94,7 +94,7 @@
 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.
  *
--- a/include/SDL_thread.h	Sat Aug 17 20:46:34 2013 -0400
+++ b/include/SDL_thread.h	Sun Aug 18 11:08:52 2013 +0200
@@ -51,9 +51,10 @@
 /* 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 @@
     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);