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 76539a0e274b8aa7
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
     1.1 --- a/include/SDL_main.h	Sat Aug 17 20:46:34 2013 -0400
     1.2 +++ b/include/SDL_main.h	Sun Aug 18 11:08:52 2013 +0200
     1.3 @@ -94,7 +94,7 @@
     1.4  extern "C" {
     1.5  #endif
     1.6  
     1.7 -/*
     1.8 +/**
     1.9   *  This is called by the real SDL main function to let the rest of the
    1.10   *  library know that initialization was done properly.
    1.11   *
     2.1 --- a/include/SDL_thread.h	Sat Aug 17 20:46:34 2013 -0400
     2.2 +++ b/include/SDL_thread.h	Sun Aug 18 11:08:52 2013 +0200
     2.3 @@ -51,9 +51,10 @@
     2.4  /* Thread local storage ID, 0 is the invalid ID */
     2.5  typedef unsigned int SDL_TLSID;
     2.6  
     2.7 -/* The SDL thread priority
     2.8 +/**
     2.9 + *  The SDL thread priority.
    2.10   *
    2.11 - * Note: On many systems you require special privileges to set high priority.
    2.12 + *  \note On many systems you require special privileges to set high priority.
    2.13   */
    2.14  typedef enum {
    2.15      SDL_THREAD_PRIORITY_LOW,
    2.16 @@ -61,8 +62,9 @@
    2.17      SDL_THREAD_PRIORITY_HIGH
    2.18  } SDL_ThreadPriority;
    2.19  
    2.20 -/* The function passed to SDL_CreateThread()
    2.21 -   It is passed a void* user context parameter and returns an int.
    2.22 +/**
    2.23 + *  The function passed to SDL_CreateThread().
    2.24 + *  It is passed a void* user context parameter and returns an int.
    2.25   */
    2.26  typedef int (SDLCALL * SDL_ThreadFunction) (void *data);
    2.27