include/SDL_loadso.h
changeset 1895 c121d94672cb
parent 1358 c71e05b4dc2e
child 2859 99210400e8b9
--- a/include/SDL_loadso.h	Thu Jul 06 18:01:37 2006 +0000
+++ b/include/SDL_loadso.h	Mon Jul 10 21:04:37 2006 +0000
@@ -20,23 +20,24 @@
     slouken@libsdl.org
 */
 
-/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-/* 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. :)
-*/
-
+/**
+ * \file SDL_loadso.h
+ *
+ * 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. :)
+ */
 
 #ifndef _SDL_loadso_h
 #define _SDL_loadso_h
@@ -47,28 +48,35 @@
 #include "begin_code.h"
 /* Set up for C function definitions, even when using C++ */
 #ifdef __cplusplus
+/* *INDENT-OFF* */
 extern "C" {
+/* *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.
  */
-extern DECLSPEC void * SDLCALL SDL_LoadObject(const char *sofile);
+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().
  */
-extern DECLSPEC void * SDLCALL SDL_LoadFunction(void *handle, const char *name);
+extern DECLSPEC void *SDLCALL SDL_LoadFunction(void *handle,
+                                               const char *name);
 
 /* Unload a shared object from memory */
 extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle);
 
 /* Ends C function definitions when using C++ */
 #ifdef __cplusplus
+/* *INDENT-OFF* */
 }
+/* *INDENT-ON* */
 #endif
 #include "close_code.h"
 
 #endif /* _SDL_loadso_h */
+
+/* vi: set ts=4 sw=4 expandtab: */