From 8cf730554b77ce4f91eee14f60c5fcfaaca4f845 Mon Sep 17 00:00:00 2001 From: Philipp Wiesemann Date: Sun, 18 Aug 2013 11:08:52 +0200 Subject: [PATCH] Changed some documentation comments in header files to be used by doxygen. --- include/SDL_main.h | 2 +- include/SDL_thread.h | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/include/SDL_main.h b/include/SDL_main.h index bbb7e859b3386..b7e4a10e5ef3d 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 c878c3ab9cca4..f248c3d69cea5 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);