include/begin_code.h
branchSDL-1.2
changeset 4217 4c4113c2162c
parent 4193 430e6690c4cd
child 4891 0d4756e57224
     1.1 --- a/include/begin_code.h	Mon Sep 21 09:27:08 2009 +0000
     1.2 +++ b/include/begin_code.h	Mon Sep 21 09:38:10 2009 +0000
     1.3 @@ -20,18 +20,26 @@
     1.4      slouken@libsdl.org
     1.5  */
     1.6  
     1.7 -/* This file sets things up for C dynamic library function definitions,
     1.8 -   static inlined functions, and structures aligned at 4-byte alignment.
     1.9 -   If you don't like ugly C preprocessor code, don't look at this file. :)
    1.10 -*/
    1.11 +/** 
    1.12 + *  @file begin_code.h
    1.13 + *  This file sets things up for C dynamic library function definitions,
    1.14 + *  static inlined functions, and structures aligned at 4-byte alignment.
    1.15 + *  If you don't like ugly C preprocessor code, don't look at this file. :)
    1.16 + */
    1.17  
    1.18 -/* This shouldn't be nested -- included it around code only. */
    1.19 +/** 
    1.20 + *  @file begin_code.h
    1.21 + *  This shouldn't be nested -- included it around code only.
    1.22 + */
    1.23  #ifdef _begin_code_h
    1.24  #error Nested inclusion of begin_code.h
    1.25  #endif
    1.26  #define _begin_code_h
    1.27  
    1.28 -/* Some compilers use a special export keyword */
    1.29 +/** 
    1.30 + *  @def DECLSPEC
    1.31 + *  Some compilers use a special export keyword
    1.32 + */
    1.33  #ifndef DECLSPEC
    1.34  # if defined(__BEOS__) || defined(__HAIKU__)
    1.35  #  if defined(__GNUC__)
    1.36 @@ -77,7 +85,10 @@
    1.37  # endif
    1.38  #endif
    1.39  
    1.40 -/* By default SDL uses the C calling convention */
    1.41 +/** 
    1.42 + *  @def SDLCALL
    1.43 + *  By default SDL uses the C calling convention
    1.44 + */
    1.45  #ifndef SDLCALL
    1.46  # if defined(__WIN32__) && !defined(__GNUC__)
    1.47  #  define SDLCALL __cdecl
    1.48 @@ -107,10 +118,12 @@
    1.49  #endif /* !EKA2 */
    1.50  #endif /* __SYMBIAN32__ */
    1.51  
    1.52 -/* Force structure packing at 4 byte alignment.
    1.53 -   This is necessary if the header is included in code which has structure
    1.54 -   packing set to an alternate value, say for loading structures from disk.
    1.55 -   The packing is reset to the previous value in close_code.h
    1.56 +/**
    1.57 + *  @file begin_code.h
    1.58 + *  Force structure packing at 4 byte alignment.
    1.59 + *  This is necessary if the header is included in code which has structure
    1.60 + *  packing set to an alternate value, say for loading structures from disk.
    1.61 + *  The packing is reset to the previous value in close_code.h 
    1.62   */
    1.63  #if defined(_MSC_VER) || defined(__MWERKS__) || defined(__BORLANDC__)
    1.64  #ifdef _MSC_VER
    1.65 @@ -125,7 +138,10 @@
    1.66  #pragma enumsalwaysint on
    1.67  #endif /* Compiler needs structure packing set */
    1.68  
    1.69 -/* Set up compiler-specific options for inlining functions */
    1.70 +/**
    1.71 + *  @def SDL_INLINE_OKAY
    1.72 + *  Set up compiler-specific options for inlining functions
    1.73 + */
    1.74  #ifndef SDL_INLINE_OKAY
    1.75  #ifdef __GNUC__
    1.76  #define SDL_INLINE_OKAY
    1.77 @@ -150,15 +166,20 @@
    1.78  #endif /* GNU C */
    1.79  #endif /* SDL_INLINE_OKAY */
    1.80  
    1.81 -/* If inlining isn't supported, remove "__inline__", turning static
    1.82 -   inlined functions into static functions (resulting in code bloat
    1.83 -   in all files which include the offending header files)
    1.84 -*/
    1.85 +/**
    1.86 + *  @def __inline__
    1.87 + *  If inlining isn't supported, remove "__inline__", turning static
    1.88 + *  inlined functions into static functions (resulting in code bloat
    1.89 + *  in all files which include the offending header files)
    1.90 + */
    1.91  #ifndef SDL_INLINE_OKAY
    1.92  #define __inline__
    1.93  #endif
    1.94  
    1.95 -/* Apparently this is needed by several Windows compilers */
    1.96 +/**
    1.97 + *  @def NULL
    1.98 + *  Apparently this is needed by several Windows compilers
    1.99 + */
   1.100  #if !defined(__MACH__)
   1.101  #ifndef NULL
   1.102  #ifdef __cplusplus