include/SDL_loadso.h
branchSDL-1.2
changeset 4217 4c4113c2162c
parent 4159 a1b03ba2fcd0
child 6137 4720145f848b
     1.1 --- a/include/SDL_loadso.h	Mon Sep 21 09:27:08 2009 +0000
     1.2 +++ b/include/SDL_loadso.h	Mon Sep 21 09:38:10 2009 +0000
     1.3 @@ -20,22 +20,24 @@
     1.4      slouken@libsdl.org
     1.5  */
     1.6  
     1.7 -/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
     1.8 -/* System dependent library loading routines                           */
     1.9 +/** @file SDL_loadso.h
    1.10 + *  System dependent library loading routines
    1.11 + */
    1.12  
    1.13 -/* Some things to keep in mind:                                        
    1.14 -   - These functions only work on C function names.  Other languages may
    1.15 -     have name mangling and intrinsic language support that varies from
    1.16 -     compiler to compiler.
    1.17 -   - Make sure you declare your function pointers with the same calling
    1.18 -     convention as the actual library function.  Your code will crash
    1.19 -     mysteriously if you do not do this.
    1.20 -   - Avoid namespace collisions.  If you load a symbol from the library,
    1.21 -     it is not defined whether or not it goes into the global symbol
    1.22 -     namespace for the application.  If it does and it conflicts with
    1.23 -     symbols in your code or other shared libraries, you will not get
    1.24 -     the results you expect. :)
    1.25 -*/
    1.26 +/** @file SDL_loadso.h
    1.27 + *  Some things to keep in mind:                                        
    1.28 + *  - These functions only work on C function names.  Other languages may
    1.29 + *    have name mangling and intrinsic language support that varies from
    1.30 + *    compiler to compiler.
    1.31 + *  - Make sure you declare your function pointers with the same calling
    1.32 + *    convention as the actual library function.  Your code will crash
    1.33 + *    mysteriously if you do not do this.
    1.34 + *  - Avoid namespace collisions.  If you load a symbol from the library,
    1.35 + *    it is not defined whether or not it goes into the global symbol
    1.36 + *    namespace for the application.  If it does and it conflicts with
    1.37 + *    symbols in your code or other shared libraries, you will not get
    1.38 + *    the results you expect. :)
    1.39 + */
    1.40  
    1.41  
    1.42  #ifndef _SDL_loadso_h
    1.43 @@ -50,19 +52,21 @@
    1.44  extern "C" {
    1.45  #endif
    1.46  
    1.47 -/* This function dynamically loads a shared object and returns a pointer
    1.48 +/**
    1.49 + * This function dynamically loads a shared object and returns a pointer
    1.50   * to the object handle (or NULL if there was an error).
    1.51   * The 'sofile' parameter is a system dependent name of the object file.
    1.52   */
    1.53  extern DECLSPEC void * SDLCALL SDL_LoadObject(const char *sofile);
    1.54  
    1.55 -/* Given an object handle, this function looks up the address of the
    1.56 +/**
    1.57 + * Given an object handle, this function looks up the address of the
    1.58   * named function in the shared object and returns it.  This address
    1.59   * is no longer valid after calling SDL_UnloadObject().
    1.60   */
    1.61  extern DECLSPEC void * SDLCALL SDL_LoadFunction(void *handle, const char *name);
    1.62  
    1.63 -/* Unload a shared object from memory */
    1.64 +/** Unload a shared object from memory */
    1.65  extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle);
    1.66  
    1.67  /* Ends C function definitions when using C++ */