Added and fixed doxygen markup in header file.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
diff --git a/include/SDL_system.h b/include/SDL_system.h
index 78d5b0d..65d3786 100644
--- a/include/SDL_system.h
+++ b/include/SDL_system.h
@@ -43,19 +43,25 @@ extern "C" {
/* Platform specific functions for Windows */
#ifdef __WIN32__
-/* Returns the D3D9 adapter index that matches the specified display index.
+/**
+ \brief Returns the D3D9 adapter index that matches the specified display index.
+
This adapter index can be passed to IDirect3D9::CreateDevice and controls
on which monitor a full screen application will appear.
*/
extern DECLSPEC int SDLCALL SDL_Direct3D9GetAdapterIndex( int displayIndex );
-/* Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
+typedef struct IDirect3DDevice9 IDirect3DDevice9;
+/**
+ \brief Returns the D3D device associated with a renderer, or NULL if it's not a D3D renderer.
+
Once you are done using the device, you should release it to avoid a resource leak.
*/
-typedef struct IDirect3DDevice9 IDirect3DDevice9;
extern DECLSPEC IDirect3DDevice9* SDLCALL SDL_RenderGetD3D9Device(SDL_Renderer * renderer);
-/* Returns the DXGI Adapter and Output indices for the specified display index.
+/**
+ \brief Returns the DXGI Adapter and Output indices for the specified display index.
+
These can be passed to EnumAdapters and EnumOutputs respectively to get the objects
required to create a DX10 or DX11 device and swap chain.
*/
@@ -76,12 +82,16 @@ extern DECLSPEC void SDLCALL SDL_iPhoneSetEventPump(SDL_bool enabled);
/* Platform specific functions for Android */
#if defined(__ANDROID__) && __ANDROID__
-/* Get the JNI environment for the current thread
+/**
+ \brief Get the JNI environment for the current thread
+
This returns JNIEnv*, but the prototype is void* so we don't need jni.h
*/
extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
-/* Get the SDL Activity object for the application
+/**
+ \brief Get the SDL Activity object for the application
+
This returns jobject, but the prototype is void* so we don't need jni.h
The jobject returned by SDL_AndroidGetActivity is a local reference.
It is the caller's responsibility to properly release it
@@ -89,26 +99,33 @@ extern DECLSPEC void * SDLCALL SDL_AndroidGetJNIEnv();
*/
extern DECLSPEC void * SDLCALL SDL_AndroidGetActivity();
-/* See the official Android developer guide for more information:
+/**
+ See the official Android developer guide for more information:
http://developer.android.com/guide/topics/data/data-storage.html
*/
#define SDL_ANDROID_EXTERNAL_STORAGE_READ 0x01
#define SDL_ANDROID_EXTERNAL_STORAGE_WRITE 0x02
-/* Get the path used for internal storage for this application.
+/**
+ \brief Get the path used for internal storage for this application.
+
This path is unique to your application and cannot be written to
by other applications.
*/
extern DECLSPEC const char * SDLCALL SDL_AndroidGetInternalStoragePath();
-/* Get the current state of external storage, a bitmask of these values:
+/**
+ \brief Get the current state of external storage, a bitmask of these values:
SDL_ANDROID_EXTERNAL_STORAGE_READ
SDL_ANDROID_EXTERNAL_STORAGE_WRITE
+
If external storage is currently unavailable, this will return 0.
*/
extern DECLSPEC int SDLCALL SDL_AndroidGetExternalStorageState();
-/* Get the path used for external storage for this application.
+/**
+ \brief Get the path used for external storage for this application.
+
This path is unique to your application, but is public and can be
written to by other applications.
*/
@@ -151,7 +168,7 @@ typedef enum
* http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
*
* \param pathType The type of path to retrieve.
- * \ret A UCS-2 string (16-bit, wide-char) containing the path, or NULL
+ * \return A UCS-2 string (16-bit, wide-char) containing the path, or NULL
* if the path is not available for any reason. Not all paths are
* available on all versions of Windows. This is especially true on
* Windows Phone. Check the documentation for the given
@@ -168,7 +185,7 @@ extern DECLSPEC const wchar_t * SDLCALL SDL_WinRTGetFSPathUNICODE(SDL_WinRT_Path
* http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx
*
* \param pathType The type of path to retrieve.
- * \ret A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
+ * \return A UTF-8 string (8-bit, multi-byte) containing the path, or NULL
* if the path is not available for any reason. Not all paths are
* available on all versions of Windows. This is especially true on
* Windows Phone. Check the documentation for the given