Improved doxygen/idl docs for LoginHelper.

git-svn-id: http://svn.gnome.org/svn/at-spi/trunk@720 e2bd861d-eb25-0410-b326-f6ed22b6b98c

1 files changed, 12 insertions, 23 deletions

diff --git a/idl/Accessibility_LoginHelper.idl b/idl/Accessibility_LoginHelper.idl
index c3cd7a8a..47838ae4 100644
--- a/idl/Accessibility_LoginHelper.idl
+++ b/idl/Accessibility_LoginHelper.idl
@@ -79,34 +79,23 @@ module Accessibility {
 
       /*
        * DeviceReq:
-       * @Accessibility_LoginHelper_GUI_EVENTS: Needs access to the GUI event subsystem (e.g. Xserver).
-       * @Accessibility_LoginHelper_CORE_KEYBOARD Needs access to the system keyboard events (read and write).
-       * @Accessibility_LoginHelper_CORE_POINTER: Needs access to the onscreen pointer (e.g. mouse pointer).
-       * @Accessibility_LoginHelper_EXT_INPUT: Reads XInput extended input devices.
-       * @Accessibility_LoginHelper_POST_WINDOWS: Posts Windows, and needs for toplevel windows to be visible
-       * @Accessibility_LoginHelper_AUDIO_OUT: Writes to audio device.
-       * @Accessibility_LoginHelper_AUDIO_IN: Reads from audio device.
-       * @Accessibility_LoginHelper_NETWORK: Requires access to general network services, including remote access.
-       * @Accessibility_LoginHelper_LOCALHOST: Requires network services hosted on LOCALHOST only.
-       * @Accessibility_LoginHelper_SERIAL_OUT: Writes to a serial port.
-       * @Accessibility_LoginHelper_SERIAL_IN: Reads from a serial port.
        *
        * The system and device access and services which the @LoginHelper-implementing 
        * assistive technology requires in order to enable the user to use the system.
        *
        */
       enum DeviceReq {
-	  GUI_EVENTS,
-	  CORE_KEYBOARD,
-	  CORE_POINTER,
-	  EXT_INPUT,
-	  POST_WINDOWS,
-	  AUDIO_OUT,
-	  AUDIO_IN,
-	  NETWORK,
-	  LOCALHOST,
-	  SERIAL_OUT,
-	  SERIAL_IN
+	  GUI_EVENTS, /*!<: Needs access to the GUI event subsystem (e.g. Xserver) */
+	  CORE_KEYBOARD, /*!<: Needs access to the system keyboard events (read and write) */
+	  CORE_POINTER, /*!<: Needs access to the onscreen pointer (e.g. mouse pointer) */
+			  EXT_INPUT, /*!<: Reads XInput extended input devices */
+	  POST_WINDOWS, /*!<: Posts Windows, and needs for toplevel windows to be visible */
+	  AUDIO_OUT, /*!<: Writes to audio device */
+	  AUDIO_IN, /*!<: Reads from audio device */
+	  NETWORK, /*!<: Requires access to general network services, including remote access */
+	  LOCALHOST, /*!<: Requires network services hosted on LOCALHOST only */
+	  SERIAL_OUT, /*!<: Writes to a serial port */
+	  SERIAL_IN /*!<: Reads from a serial port */
       };
 
       typedef sequence<DeviceReq> DeviceReqList;
@@ -136,7 +125,7 @@ module Accessibility {
 	 *    events will include 
 	 *    Accessibility_LoginHelper_CORE_KEYBOARD in this list.
 	 *
-         * Returns: A sequence of @LoginHelper_DeviceFlags indicating
+         * Returns: A sequence of @LoginHelper_DeviceReq indicating
 	 *    the device I/O required in order to facilitate end-user access 
 	 *    to the system.
 	 **/