include/SDL_loadso.h
changeset 3407 d3baf5ac4e37
parent 2859 99210400e8b9
child 3697 f7b03b6838cb
     1.1 --- a/include/SDL_loadso.h	Sun Oct 18 23:21:15 2009 +0000
     1.2 +++ b/include/SDL_loadso.h	Mon Oct 19 13:31:58 2009 +0000
     1.3 @@ -21,22 +21,22 @@
     1.4  */
     1.5  
     1.6  /**
     1.7 - * \file SDL_loadso.h
     1.8 + *  \file SDL_loadso.h
     1.9   *
    1.10 - * System dependent library loading routines
    1.11 + *  System dependent library loading routines
    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 + *  Some things to keep in mind:                                        
    1.26 + *  \li These functions only work on C function names.  Other languages may
    1.27 + *      have name mangling and intrinsic language support that varies from
    1.28 + *      compiler to compiler.
    1.29 + *  \li Make sure you declare your function pointers with the same calling
    1.30 + *      convention as the actual library function.  Your code will crash
    1.31 + *      mysteriously if you do not do this.
    1.32 + *  \li Avoid namespace collisions.  If you load a symbol from the library,
    1.33 + *      it is not defined whether or not it goes into the global symbol
    1.34 + *      namespace for the application.  If it does and it conflicts with
    1.35 + *      symbols in your code or other shared libraries, you will not get
    1.36 + *      the results you expect. :)
    1.37   */
    1.38  
    1.39  #ifndef _SDL_loadso_h
    1.40 @@ -53,20 +53,24 @@
    1.41  /* *INDENT-ON* */
    1.42  #endif
    1.43  
    1.44 -/* This function dynamically loads a shared object and returns a pointer
    1.45 - * to the object handle (or NULL if there was an error).
    1.46 - * The 'sofile' parameter is a system dependent name of the object file.
    1.47 +/**
    1.48 + *  This function dynamically loads a shared object and returns a pointer
    1.49 + *  to the object handle (or NULL if there was an error).
    1.50 + *  The 'sofile' parameter is a system dependent name of the object file.
    1.51   */
    1.52  extern DECLSPEC void *SDLCALL SDL_LoadObject(const char *sofile);
    1.53  
    1.54 -/* Given an object handle, this function looks up the address of the
    1.55 - * named function in the shared object and returns it.  This address
    1.56 - * is no longer valid after calling SDL_UnloadObject().
    1.57 +/**
    1.58 + *  Given an object handle, this function looks up the address of the
    1.59 + *  named function in the shared object and returns it.  This address
    1.60 + *  is no longer valid after calling SDL_UnloadObject().
    1.61   */
    1.62  extern DECLSPEC void *SDLCALL SDL_LoadFunction(void *handle,
    1.63                                                 const char *name);
    1.64  
    1.65 -/* Unload a shared object from memory */
    1.66 +/**
    1.67 + *  Unload a shared object from memory.
    1.68 + */
    1.69  extern DECLSPEC void SDLCALL SDL_UnloadObject(void *handle);
    1.70  
    1.71  /* Ends C function definitions when using C++ */