diff include/SDL_thread.h @ 3407:d3baf5ac4e37

Partial fix for bug #859 Header file update from Ken for improved doxygen output
author Sam Lantinga <slouken@libsdl.org>
date Mon, 19 Oct 2009 13:31:58 +0000
parents a67a961e2171
children 0d1b16ee0bca
line wrap: on
line diff
--- a/include/SDL_thread.h	Sun Oct 18 23:21:15 2009 +0000
+++ b/include/SDL_thread.h	Mon Oct 19 13:31:58 2009 +0000
@@ -24,9 +24,9 @@
 #define _SDL_thread_h
 
 /**
- * \file SDL_thread.h
- *
- * Header for the SDL thread management routines 
+ *  \file SDL_thread.h
+ *  
+ *  Header for the SDL thread management routines.
  */
 
 #include "SDL_stdinc.h"
@@ -47,21 +47,27 @@
 struct SDL_Thread;
 typedef struct SDL_Thread SDL_Thread;
 
-/* Create a thread */
 #if defined(__WIN32__) && !defined(HAVE_LIBC)
-/*
-   We compile SDL into a DLL. This means, that it's the DLL which
-   creates a new thread for the calling process with the SDL_CreateThread()
-   API. There is a problem with this, that only the RTL of the SDL.DLL will
-   be initialized for those threads, and not the RTL of the calling application!
-   To solve this, we make a little hack here.
-   We'll always use the caller's _beginthread() and _endthread() APIs to
-   start a new thread. This way, if it's the SDL.DLL which uses this API,
-   then the RTL of SDL.DLL will be used to create the new thread, and if it's
-   the application, then the RTL of the application will be used.
-   So, in short:
-   Always use the _beginthread() and _endthread() of the calling runtime library!
-*/
+/**
+ *  \file SDL_thread.h
+ *  
+ *  We compile SDL into a DLL. This means, that it's the DLL which
+ *  creates a new thread for the calling process with the SDL_CreateThread()
+ *  API. There is a problem with this, that only the RTL of the SDL.DLL will
+ *  be initialized for those threads, and not the RTL of the calling 
+ *  application!
+ *  
+ *  To solve this, we make a little hack here.
+ *  
+ *  We'll always use the caller's _beginthread() and _endthread() APIs to
+ *  start a new thread. This way, if it's the SDL.DLL which uses this API,
+ *  then the RTL of SDL.DLL will be used to create the new thread, and if it's
+ *  the application, then the RTL of the application will be used.
+ *  
+ *  So, in short:
+ *  Always use the _beginthread() and _endthread() of the calling runtime 
+ *  library!
+ */
 #define SDL_PASSED_BEGINTHREAD_ENDTHREAD
 #ifndef _WIN32_WCE
 #include <process.h>            /* This has _beginthread() and _endthread() defined! */
@@ -87,40 +93,66 @@
 typedef void (__cdecl * pfnSDL_CurrentEndThread) (unsigned code);
 #endif
 
+/**
+ *  Create a thread.
+ */
 extern DECLSPEC SDL_Thread *SDLCALL
 SDL_CreateThread(int (SDLCALL * f) (void *), void *data,
                  pfnSDL_CurrentBeginThread pfnBeginThread,
                  pfnSDL_CurrentEndThread pfnEndThread);
 
 #if defined(_WIN32_WCE)
+
+/**
+ *  Create a thread.
+ */
 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, NULL, NULL)
+
 #else
+
+/**
+ *  Create a thread.
+ */
 #define SDL_CreateThread(fn, data) SDL_CreateThread(fn, data, _beginthreadex, _endthreadex)
+
 #endif
 #else
+
+/**
+ *  Create a thread.
+ */
 extern DECLSPEC SDL_Thread *SDLCALL
 SDL_CreateThread(int (SDLCALL * fn) (void *), void *data);
+
 #endif
 
-/* Get the 32-bit thread identifier for the current thread */
+/**
+ *  Get the 32-bit thread identifier for the current thread.
+ */
 extern DECLSPEC Uint32 SDLCALL SDL_ThreadID(void);
 
-/* Get the 32-bit thread identifier for the specified thread,
-   equivalent to SDL_ThreadID() if the specified thread is NULL.
+/**
+ *  Get the 32-bit thread identifier for the specified thread.
+ *  
+ *  Equivalent to SDL_ThreadID() if the specified thread is NULL.
  */
 extern DECLSPEC Uint32 SDLCALL SDL_GetThreadID(SDL_Thread * thread);
 
-/* Wait for a thread to finish.
-   The return code for the thread function is placed in the area
-   pointed to by 'status', if 'status' is not NULL.
+/**
+ *  Wait for a thread to finish.
+ *  
+ *  The return code for the thread function is placed in the area
+ *  pointed to by \c status, if \c status is not NULL.
  */
 extern DECLSPEC void SDLCALL SDL_WaitThread(SDL_Thread * thread, int *status);
 
-/* This function is here for binary compatibility with legacy apps, but
-   in SDL 1.3 and later, it's a no-op. You cannot forcibly kill a thread
-   in a safe manner on many platforms. You should instead find a way to
-   alert your thread that it is time to terminate, and then have it gracefully
-   exit on its own. Do not ever call this function!
+/**
+ *  \deprecated This function is here for binary compatibility with legacy apps,
+ *              but in SDL 1.3 and later, it's a no-op.
+ *  
+ *  You cannot forcibly kill a thread in a safe manner on many platforms. You 
+ *  should instead find a way to alert your thread that it is time to terminate,
+ *  and then have it gracefully exit on its own. Do not ever call this function!
  */
 extern DECLSPEC void SDLCALL SDL_KillThread(SDL_Thread * thread);