diff include/SDL_syswm.h @ 3407:d3baf5ac4e37

Partial fix for bug #859 Header file update from Ken for improved doxygen output
author Sam Lantinga <slouken@libsdl.org>
date Mon, 19 Oct 2009 13:31:58 +0000
parents 08574b033f37
children 64ce267332c6
line wrap: on
line diff
--- a/include/SDL_syswm.h	Sun Oct 18 23:21:15 2009 +0000
+++ b/include/SDL_syswm.h	Mon Oct 19 13:31:58 2009 +0000
@@ -21,9 +21,9 @@
 */
 
 /**
- * \file SDL_syswm.h
- *
- * Include file for SDL custom system window manager hooks
+ *  \file SDL_syswm.h
+ *  
+ *  Include file for SDL custom system window manager hooks.
  */
 
 #ifndef _SDL_syswm_h
@@ -42,11 +42,14 @@
 /* *INDENT-ON* */
 #endif
 
-/* Your application has access to a special type of event 'SDL_SYSWMEVENT',
-   which contains window-manager specific information and arrives whenever
-   an unhandled window event occurs.  This event is ignored by default, but
-   you can enable it with SDL_EventState()
-*/
+/**
+ *  \file SDL_syswm.h
+ *  
+ *  Your application has access to a special type of event ::SDL_SYSWMEVENT,
+ *  which contains window-manager specific information and arrives whenever
+ *  an unhandled window event occurs.  This event is ignored by default, but
+ *  you can enable it with SDL_EventState().
+ */
 #ifdef SDL_PROTOTYPES_ONLY
 struct SDL_SysWMinfo;
 #else
@@ -66,13 +69,17 @@
 #undef Cursor
 #endif
 
-/* These are the various supported subsystems under UNIX */
+/** 
+ *  These are the various supported subsystems under UNIX.
+ */
 typedef enum
 {
     SDL_SYSWM_X11
 } SDL_SYSWM_TYPE;
 
-/* The UNIX custom event structure */
+/**
+ *  The UNIX custom event structure.
+ */
 struct SDL_SysWMmsg
 {
     SDL_version version;
@@ -83,9 +90,11 @@
     } event;
 };
 
-/* The UNIX custom window manager information structure.
-   When this structure is returned, it holds information about which
-   low level system it is using, and will be one of SDL_SYSWM_TYPE.
+/**
+ *  The UNIX custom window manager information structure.
+ *
+ *  When this structure is returned, it holds information about which
+ *  low level system it is using, and will be one of SDL_SYSWM_TYPE.
  */
 struct SDL_SysWMinfo
 {
@@ -95,19 +104,26 @@
     {
         struct
         {
-            Display *display;   /* The X11 display */
-            Window window;      /* The X11 display window */
-            /* These locking functions should be called around
-               any X11 functions using the display variable.
-               They lock the event thread, so should not be
-               called around event functions or from event filters.
+            Display *display;   /**< The X11 display */
+            Window window;      /**< The X11 display window */
+            /**
+             *  These locking functions should be called around
+             *  any X11 functions using the display variable.
+             *  They lock the event thread, so should not be
+             *  called around event functions or from event filters.
              */
+            /*@{*/
             void (*lock_func) (void);
             void (*unlock_func) (void);
+            /*@}*/
 
-            /* Introduced in SDL 1.0.2 */
-            Window fswindow;    /* The X11 fullscreen window */
-            Window wmwindow;    /* The X11 managed input window */
+            /**
+             *  Introduced in SDL 1.0.2.
+             */
+            /*@{*/
+            Window fswindow;    /**< The X11 fullscreen window */
+            Window wmwindow;    /**< The X11 managed input window */
+            /*@}*/
         } x11;
     } info;
 };
@@ -116,40 +132,48 @@
 #define WIN32_LEAN_AND_MEAN
 #include <windows.h>
 
-/* The windows custom event structure */
+/**
+ *  The windows custom event structure.
+ */
 struct SDL_SysWMmsg
 {
     SDL_version version;
-    HWND hwnd;                  /* The window for the message */
-    UINT msg;                   /* The type of message */
-    WPARAM wParam;              /* WORD message parameter */
-    LPARAM lParam;              /* LONG message parameter */
+    HWND hwnd;                  /**< The window for the message */
+    UINT msg;                   /**< The type of message */
+    WPARAM wParam;              /**< WORD message parameter */
+    LPARAM lParam;              /**< LONG message parameter */
 };
 
-/* The windows custom window manager information structure */
+/**
+ *  The windows custom window manager information structure.
+ */
 struct SDL_SysWMinfo
 {
     SDL_version version;
-    HWND window;                /* The Win32 display window */
+    HWND window;                /**< The Win32 display window */
 };
 
 #elif defined(SDL_VIDEO_DRIVER_RISCOS)
 
-/* RISC OS custom event structure */
+/**
+ *  RISC OS custom event structure.
+ */
 struct SDL_SysWMmsg
 {
     SDL_version version;
-    int eventCode;              /* The window for the message */
+    int eventCode;              /**< The window for the message */
     int pollBlock[64];
 };
 
-/* The RISC OS custom window manager information structure */
+/**
+ *  The RISC OS custom window manager information structure.
+ */
 struct SDL_SysWMinfo
 {
     SDL_version version;
-    int wimpVersion;            /* Wimp version running under */
-    int taskHandle;             /* The RISC OS task handle */
-    int window;                 /* The RISC OS display window */
+    int wimpVersion;            /**< Wimp version running under */
+    int taskHandle;             /**< The RISC OS task handle */
+    int window;                 /**< The RISC OS display window */
 };
 
 #elif defined(SDL_VIDEO_DRIVER_PHOTON) || defined(SDL_VIDEO_DRIVER_QNXGF)
@@ -159,14 +183,18 @@
 #endif /* SDL_VIDEO_OPENGL_ES */
 #include <Ph.h>
 
-/* The QNX custom event structure */
+/**
+ * The QNX custom event structure.
+ */
 struct SDL_SysWMmsg
 {
     SDL_version version;
     int data;
 };
 
-/* The QNX Photon custom window manager information structure */
+/**
+ *  The QNX Photon custom window manager information structure.
+ */
 struct SDL_SysWMinfo
 {
     SDL_version version;
@@ -175,14 +203,18 @@
 
 #else
 
-/* The generic custom event structure */
+/**
+ *  The generic custom event structure.
+ */
 struct SDL_SysWMmsg
 {
     SDL_version version;
     int data;
 };
 
-/* The generic custom window manager information structure */
+/**
+ *  The generic custom window manager information structure.
+ */
 struct SDL_SysWMinfo
 {
     SDL_version version;
@@ -197,21 +229,21 @@
 
 /* Function prototypes */
 /**
- * \fn SDL_bool SDL_GetWindowWMInfo (SDL_WindowID windowID, SDL_SysWMinfo * info)
- *
- * \brief This function allows access to driver-dependent window information.
- *
- * \param windowID The window about which information is being requested
- * \param info This structure must be initialized with the SDL version, and is then filled in with information about the given window.
- *
- * \return SDL_TRUE if the function is implemented and the version member of the 'info' struct is valid, SDL_FALSE otherwise.
- *
- * You typically use this function like this:
- * \code
- * SDL_SysWMInfo info;
- * SDL_VERSION(&info.version);
- * if ( SDL_GetWindowWMInfo(&info) ) { ... }
- * \endcode
+ *  \brief This function allows access to driver-dependent window information.
+ *  
+ *  \param windowID The window about which information is being requested
+ *  \param info This structure must be initialized with the SDL version, and is 
+ *              then filled in with information about the given window.
+ *  
+ *  \return SDL_TRUE if the function is implemented and the version member of 
+ *          the \c info struct is valid, SDL_FALSE otherwise.
+ *  
+ *  You typically use this function like this:
+ *  \code
+ *  SDL_SysWMInfo info;
+ *  SDL_VERSION(&info.version);
+ *  if ( SDL_GetWindowWMInfo(&info) ) { ... }
+ *  \endcode
  */
 extern DECLSPEC SDL_bool SDLCALL SDL_GetWindowWMInfo(SDL_WindowID windowID,
                                                      SDL_SysWMinfo * info);