Partial fix for bug #859

Header file update from Ken for improved doxygen output

include/SDL_rwops.h

@@ -21,10 +21,10 @@
 */
 
 /**
- * \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.
+ *  \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
@@ -41,33 +41,42 @@ extern "C" {
 /* *INDENT-ON* */
 #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:
-       RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
-       Returns the final offset in the data source.
+    /**
+     *  Seek to \c offset relative to \c whence, one of stdio's whence values:
+     *  RW_SEEK_SET, RW_SEEK_CUR, RW_SEEK_END
+     *  
+     *  \return the final offset in the data source.
      */
     long (SDLCALL * seek) (struct SDL_RWops * context, long 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 0 at error or end of file.
+    /**
+     *  Read up to \c num objects each of size \c objsize from the data
+     *  source to the area pointed at by \c ptr.
+     *  
+     *  \return the number of objects read, or 0 at error or end of file.
      */
-      size_t(SDLCALL * read) (struct SDL_RWops * context, void *ptr,
-                              size_t size, size_t maxnum);
-
-    /* Write exactly 'num' objects each of size 'objsize' from the area
-       pointed at by 'ptr' to data source.
-       Returns the number of objects written, or 0 at error or end of file.
+    size_t(SDLCALL * read) (struct SDL_RWops * context, void *ptr,
+                            size_t size, size_t maxnum);
+
+    /**
+     *  Write exactly \c num objects each of size \c objsize from the area
+     *  pointed at by \c ptr to data source.
+     *  
+     *  \return the number of objects written, or 0 at error or end of file.
      */
-      size_t(SDLCALL * write) (struct SDL_RWops * context, const void *ptr,
-                               size_t size, size_t num);
+    size_t(SDLCALL * write) (struct SDL_RWops * context, const void *ptr,
+                             size_t size, size_t num);
 
-    /* Close and free an allocated SDL_RWops structure.
-       Returns 0 if successful or -1 on write error when flushing data.
+    /**
+     *  Close and free an allocated SDL_RWops structure.
+     *  
+     *  \return 0 if successful or -1 on write error when flushing data.
      */
     int (SDLCALL * close) (struct SDL_RWops * context);
 
@@ -109,7 +118,12 @@ typedef struct SDL_RWops
 } SDL_RWops;
 
 
-/* Functions to create SDL_RWops structures from various data sources */
+/**
+ *  \name RWFrom functions
+ *  
+ *  Functions to create SDL_RWops structures from various data sources.
+ */
+/*@{*/
 
 extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromFile(const char *file,
                                                   const char *mode);
@@ -123,36 +137,57 @@ extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromMem(void *mem, int size);
 extern DECLSPEC SDL_RWops *SDLCALL SDL_RWFromConstMem(const void *mem,
                                                       int size);
 
+/*@}*//*RWFrom functions*/
+
+
 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 */
+#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 Read/write macros
+ *  
+ *  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/write macros*/
 
 
-/* Read an item of the specified endianness and return in native format */
+/** 
+ *  \name Read endian functions
+ *  
+ *  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);
+/*@}*//*Read endian functions*/
 
-/* Write an item of native format to the specified endianness */
+/** 
+ *  \name Write endian functions
+ *  
+ *  Write an item of native format to the specified endianness.
+ */
+/*@{*/
 extern DECLSPEC size_t SDLCALL SDL_WriteLE16(SDL_RWops * dst, Uint16 value);
 extern DECLSPEC size_t SDLCALL SDL_WriteBE16(SDL_RWops * dst, Uint16 value);
 extern DECLSPEC size_t SDLCALL SDL_WriteLE32(SDL_RWops * dst, Uint32 value);
 extern DECLSPEC size_t SDLCALL SDL_WriteBE32(SDL_RWops * dst, Uint32 value);
 extern DECLSPEC size_t SDLCALL SDL_WriteLE64(SDL_RWops * dst, Uint64 value);
 extern DECLSPEC size_t SDLCALL SDL_WriteBE64(SDL_RWops * dst, Uint64 value);
+/*@}*//*Write endian functions*/
 
 
 /* Ends C function definitions when using C++ */