include/SDL_cpuinfo.h
branchSDL-1.2
changeset 4217 4c4113c2162c
parent 4159 a1b03ba2fcd0
child 6137 4720145f848b
     1.1 --- a/include/SDL_cpuinfo.h	Mon Sep 21 09:27:08 2009 +0000
     1.2 +++ b/include/SDL_cpuinfo.h	Mon Sep 21 09:38:10 2009 +0000
     1.3 @@ -20,8 +20,10 @@
     1.4      slouken@libsdl.org
     1.5  */
     1.6  
     1.7 -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
     1.8 -/* CPU feature detection for SDL                                       */
     1.9 +/**
    1.10 + *  @file SDL_cpuinfo.h
    1.11 + *  CPU feature detection for SDL
    1.12 + */
    1.13  
    1.14  #ifndef _SDL_cpuinfo_h
    1.15  #define _SDL_cpuinfo_h
    1.16 @@ -34,36 +36,28 @@
    1.17  extern "C" {
    1.18  #endif
    1.19  
    1.20 -/* This function returns true if the CPU has the RDTSC instruction
    1.21 - */
    1.22 +/** This function returns true if the CPU has the RDTSC instruction */
    1.23  extern DECLSPEC SDL_bool SDLCALL SDL_HasRDTSC(void);
    1.24  
    1.25 -/* This function returns true if the CPU has MMX features
    1.26 - */
    1.27 +/** This function returns true if the CPU has MMX features */
    1.28  extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void);
    1.29  
    1.30 -/* This function returns true if the CPU has MMX Ext. features
    1.31 - */
    1.32 +/** This function returns true if the CPU has MMX Ext. features */
    1.33  extern DECLSPEC SDL_bool SDLCALL SDL_HasMMXExt(void);
    1.34  
    1.35 -/* This function returns true if the CPU has 3DNow features
    1.36 - */
    1.37 +/** This function returns true if the CPU has 3DNow features */
    1.38  extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNow(void);
    1.39  
    1.40 -/* This function returns true if the CPU has 3DNow! Ext. features
    1.41 - */
    1.42 +/** This function returns true if the CPU has 3DNow! Ext. features */
    1.43  extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNowExt(void);
    1.44  
    1.45 -/* This function returns true if the CPU has SSE features
    1.46 - */
    1.47 +/** This function returns true if the CPU has SSE features */
    1.48  extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void);
    1.49  
    1.50 -/* This function returns true if the CPU has SSE2 features
    1.51 - */
    1.52 +/** This function returns true if the CPU has SSE2 features */
    1.53  extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void);
    1.54  
    1.55 -/* This function returns true if the CPU has AltiVec features
    1.56 - */
    1.57 +/** This function returns true if the CPU has AltiVec features */
    1.58  extern DECLSPEC SDL_bool SDLCALL SDL_HasAltiVec(void);
    1.59  
    1.60  /* Ends C function definitions when using C++ */