update to SDL 1.2.14

[xonotic/xonotic.git] / misc / buildfiles / osx / Xonotic-SDL.app / Contents / Frameworks / SDL.framework / Versions / A / Headers / SDL_rwops.h

diff --git a/misc/buildfiles/osx/Xonotic-SDL.app/Contents/Frameworks/SDL.framework/Versions/A/Headers/SDL_rwops.h b/misc/buildfiles/osx/Xonotic-SDL.app/Contents/Frameworks/SDL.framework/Versions/A/Headers/SDL_rwops.h
index 8c177017f5fd76a539447873dfbdeaca24b5342e..a450119f1ccb471491ee4ac438e0f966bde13671 100644 (file)
--- a/misc/buildfiles/osx/Xonotic-SDL.app/Contents/Frameworks/SDL.framework/Versions/A/Headers/SDL_rwops.h
+++ b/misc/buildfiles/osx/Xonotic-SDL.app/Contents/Frameworks/SDL.framework/Versions/A/Headers/SDL_rwops.h
@@ -1,6 +1,6 @@
 /*
     SDL - Simple DirectMedia Layer
-    Copyright (C) 1997-2006 Sam Lantinga
+    Copyright (C) 1997-2009 Sam Lantinga
 
     This library is free software; you can redistribute it and/or
     modify it under the terms of the GNU Lesser General Public
@@ -20,9 +20,10 @@
     slouken@libsdl.org
 */
 
-/* This file provides a general interface for SDL to read and write
-   data sources.  It can easily be extended to files, memory, etc.
-*/
+/** @file SDL_rwops.h
+ *  This file provides a general interface for SDL to read and write
+ *  data sources.  It can easily be extended to files, memory, etc.
+ */
 
 #ifndef _SDL_rwops_h
 #define _SDL_rwops_h
@@ -36,28 +37,28 @@
 extern "C" {
 #endif
 
-/* This is the read/write operation structure -- very basic */
+/** This is the read/write operation structure -- very basic */
 
 typedef struct SDL_RWops {
-       /* Seek to 'offset' relative to whence, one of stdio's whence values:
-               SEEK_SET, SEEK_CUR, SEEK_END
-          Returns the final offset in the data source.
+       /** Seek to 'offset' relative to whence, one of stdio's whence values:
+        *      SEEK_SET, SEEK_CUR, SEEK_END
+        *  Returns the final offset in the data source.
         */
        int (SDLCALL *seek)(struct SDL_RWops *context, int offset, int whence);
 
-       /* Read up to 'num' objects each of size 'objsize' from the data
-          source to the area pointed at by 'ptr'.
-          Returns the number of objects read, or -1 if the read failed.
+       /** Read up to 'maxnum' objects each of size 'size' from the data
+        *  source to the area pointed at by 'ptr'.
+        *  Returns the number of objects read, or -1 if the read failed.
         */
        int (SDLCALL *read)(struct SDL_RWops *context, void *ptr, int size, int maxnum);
 
-       /* Write exactly 'num' objects each of size 'objsize' from the area
-          pointed at by 'ptr' to data source.
-          Returns 'num', or -1 if the write failed.
+       /** Write exactly 'num' objects each of size 'objsize' from the area
+        *  pointed at by 'ptr' to data source.
+        *  Returns 'num', or -1 if the write failed.
         */
        int (SDLCALL *write)(struct SDL_RWops *context, const void *ptr, int size, int num);
 
-       /* Close and free an allocated SDL_FSops structure */
+       /** Close and free an allocated SDL_FSops structure */
        int (SDLCALL *close)(struct SDL_RWops *context);
 
        Uint32 type;
@@ -92,7 +93,8 @@ typedef struct SDL_RWops {
 } SDL_RWops;
 
 
-/* Functions to create SDL_RWops structures from various data sources */
+/** @name Functions to create SDL_RWops structures from various data sources */
+/*@{*/
 
 extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromFile(const char *file, const char *mode);
 
@@ -106,34 +108,43 @@ extern DECLSPEC SDL_RWops * SDLCALL SDL_RWFromConstMem(const void *mem, int size
 extern DECLSPEC SDL_RWops * SDLCALL SDL_AllocRW(void);
 extern DECLSPEC void SDLCALL SDL_FreeRW(SDL_RWops *area);
 
-#define RW_SEEK_SET    0       /* Seek from the beginning of data */
-#define RW_SEEK_CUR    1       /* Seek relative to current read point */
-#define RW_SEEK_END    2       /* Seek relative to the end of data */
+/*@}*/
+
+/** @name Seek Reference Points */
+/*@{*/
+#define RW_SEEK_SET    0       /**< Seek from the beginning of data */
+#define RW_SEEK_CUR    1       /**< Seek relative to current read point */
+#define RW_SEEK_END    2       /**< Seek relative to the end of data */
+/*@}*/
 
-/* Macros to easily read and write from an SDL_RWops structure */
+/** @name Macros to easily read and write from an SDL_RWops structure */
+/*@{*/
 #define SDL_RWseek(ctx, offset, whence)        (ctx)->seek(ctx, offset, whence)
 #define SDL_RWtell(ctx)                        (ctx)->seek(ctx, 0, RW_SEEK_CUR)
 #define SDL_RWread(ctx, ptr, size, n)  (ctx)->read(ctx, ptr, size, n)
 #define SDL_RWwrite(ctx, ptr, size, n) (ctx)->write(ctx, ptr, size, n)
 #define SDL_RWclose(ctx)               (ctx)->close(ctx)
+/*@}*/
 
-
-/* Read an item of the specified endianness and return in native format */
+/** @name Read an item of the specified endianness and return in native format */
+/*@{*/
 extern DECLSPEC Uint16 SDLCALL SDL_ReadLE16(SDL_RWops *src);
 extern DECLSPEC Uint16 SDLCALL SDL_ReadBE16(SDL_RWops *src);
 extern DECLSPEC Uint32 SDLCALL SDL_ReadLE32(SDL_RWops *src);
 extern DECLSPEC Uint32 SDLCALL SDL_ReadBE32(SDL_RWops *src);
 extern DECLSPEC Uint64 SDLCALL SDL_ReadLE64(SDL_RWops *src);
 extern DECLSPEC Uint64 SDLCALL SDL_ReadBE64(SDL_RWops *src);
+/*@}*/
 
-/* Write an item of native format to the specified endianness */
+/** @name Write an item of native format to the specified endianness */
+/*@{*/
 extern DECLSPEC int SDLCALL SDL_WriteLE16(SDL_RWops *dst, Uint16 value);
 extern DECLSPEC int SDLCALL SDL_WriteBE16(SDL_RWops *dst, Uint16 value);
 extern DECLSPEC int SDLCALL SDL_WriteLE32(SDL_RWops *dst, Uint32 value);
 extern DECLSPEC int SDLCALL SDL_WriteBE32(SDL_RWops *dst, Uint32 value);
 extern DECLSPEC int SDLCALL SDL_WriteLE64(SDL_RWops *dst, Uint64 value);
 extern DECLSPEC int SDLCALL SDL_WriteBE64(SDL_RWops *dst, Uint64 value);
-
+/*@}*/
 
 /* Ends C function definitions when using C++ */
 #ifdef __cplusplus