diff include/SDL_cpuinfo.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 99210400e8b9
children 3427271a2d75
line wrap: on
line diff
--- a/include/SDL_cpuinfo.h	Sun Oct 18 23:21:15 2009 +0000
+++ b/include/SDL_cpuinfo.h	Mon Oct 19 13:31:58 2009 +0000
@@ -21,9 +21,9 @@
 */
 
 /**
- * \file SDL_cpuinfo.h
- *
- * CPU feature detection for SDL
+ *  \file SDL_cpuinfo.h
+ *  
+ *  CPU feature detection for SDL.
  */
 
 #ifndef _SDL_cpuinfo_h
@@ -39,35 +39,43 @@
 /* *INDENT-ON* */
 #endif
 
-/* This function returns true if the CPU has the RDTSC instruction
+/**
+ *  This function returns true if the CPU has the RDTSC instruction.
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_HasRDTSC(void);
 
-/* This function returns true if the CPU has MMX features
+/**
+ *  This function returns true if the CPU has MMX features.
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMX(void);
 
-/* This function returns true if the CPU has MMX Ext. features
+/**
+ *  This function returns true if the CPU has MMX Ext.\ features.
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_HasMMXExt(void);
 
-/* This function returns true if the CPU has 3DNow features
+/**
+ *  This function returns true if the CPU has 3DNow!\ features.
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNow(void);
 
-/* This function returns true if the CPU has 3DNow! Ext. features
+/**
+ *  This function returns true if the CPU has 3DNow!\ Ext.\ features.
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_Has3DNowExt(void);
 
-/* This function returns true if the CPU has SSE features
+/**
+ *  This function returns true if the CPU has SSE features.
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE(void);
 
-/* This function returns true if the CPU has SSE2 features
+/**
+ *  This function returns true if the CPU has SSE2 features.
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_HasSSE2(void);
 
-/* This function returns true if the CPU has AltiVec features
+/**
+ *  This function returns true if the CPU has AltiVec features.
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_HasAltiVec(void);