include/SDL_loadso.h
changeset 3407 d3baf5ac4e37
parent 2859 99210400e8b9
child 3697 f7b03b6838cb
--- a/include/SDL_loadso.h	Sun Oct 18 23:21:15 2009 +0000
+++ b/include/SDL_loadso.h	Mon Oct 19 13:31:58 2009 +0000
@@ -21,22 +21,22 @@
 */
 
 /**
- * \file SDL_loadso.h
+ *  \file SDL_loadso.h
  *
- * System dependent library loading routines
+ *  System dependent library loading routines
  *
- * Some things to keep in mind:                                        
- * - These functions only work on C function names.  Other languages may
- *   have name mangling and intrinsic language support that varies from
- *   compiler to compiler.
- * - Make sure you declare your function pointers with the same calling
- *   convention as the actual library function.  Your code will crash
- *   mysteriously if you do not do this.
- * - Avoid namespace collisions.  If you load a symbol from the library,
- *   it is not defined whether or not it goes into the global symbol
- *   namespace for the application.  If it does and it conflicts with
- *   symbols in your code or other shared libraries, you will not get
- *   the results you expect. :)
+ *  Some things to keep in mind:                                        
+ *  \li These functions only work on C function names.  Other languages may
+ *      have name mangling and intrinsic language support that varies from
+ *      compiler to compiler.
+ *  \li Make sure you declare your function pointers with the same calling
+ *      convention as the actual library function.  Your code will crash
+ *      mysteriously if you do not do this.
+ *  \li Avoid namespace collisions.  If you load a symbol from the library,
+ *      it is not defined whether or not it goes into the global symbol
+ *      namespace for the application.  If it does and it conflicts with
+ *      symbols in your code or other shared libraries, you will not get
+ *      the results you expect. :)
  */
 
 #ifndef _SDL_loadso_h
@@ -53,20 +53,24 @@
 /* *INDENT-ON* */
 #endif
 
-/* This function dynamically loads a shared object and returns a pointer
- * to the object handle (or NULL if there was an error).
- * The 'sofile' parameter is a system dependent name of the object file.
+/**
+ *  This function dynamically loads a shared object and returns a pointer
+ *  to the object handle (or NULL if there was an error).
+ *  The 'sofile' parameter is a system dependent name of the object file.
  */
 extern DECLSPEC void *SDLCALL SDL_LoadObject(const char *sofile);
 
-/* Given an object handle, this function looks up the address of the
- * named function in the shared object and returns it.  This address
- * is no longer valid after calling SDL_UnloadObject().
+/**
+ *  Given an object handle, this function looks up the address of the
+ *  named function in the shared object and returns it.  This address
+ *  is no longer valid after calling SDL_UnloadObject().
  */
 extern DECLSPEC void *SDLCALL SDL_LoadFunction(void *handle,
                                                const char *name);
 
-/* Unload a shared object from memory */
+/**
+ *  Unload a shared object from memory.
+ */
 extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle);
 
 /* Ends C function definitions when using C++ */