code clenup: comments and some style edits on ghost/osx (odd indentation)
authorCampbell Barton <ideasman42@gmail.com>
Thu, 6 Sep 2012 02:10:09 +0000 (02:10 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Thu, 6 Sep 2012 02:10:09 +0000 (02:10 +0000)
78 files changed:
intern/audaspace/intern/AUD_ReferenceHandler.cpp
intern/ghost/GHOST_IEvent.h
intern/ghost/GHOST_IEventConsumer.h
intern/ghost/GHOST_ISystem.h
intern/ghost/GHOST_ISystemPaths.h
intern/ghost/GHOST_ITimerTask.h
intern/ghost/GHOST_IWindow.h
intern/ghost/GHOST_Path-api.h
intern/ghost/GHOST_Rect.h
intern/ghost/GHOST_Types.h
intern/ghost/intern/GHOST_Buttons.h
intern/ghost/intern/GHOST_CallbackEventConsumer.cpp
intern/ghost/intern/GHOST_CallbackEventConsumer.h
intern/ghost/intern/GHOST_DisplayManager.cpp
intern/ghost/intern/GHOST_DisplayManager.h
intern/ghost/intern/GHOST_DisplayManagerCarbon.cpp
intern/ghost/intern/GHOST_DisplayManagerCarbon.h
intern/ghost/intern/GHOST_DisplayManagerCocoa.h
intern/ghost/intern/GHOST_DisplayManagerWin32.h
intern/ghost/intern/GHOST_DisplayManagerX11.h
intern/ghost/intern/GHOST_DropTargetWin32.h
intern/ghost/intern/GHOST_DropTargetX11.h
intern/ghost/intern/GHOST_Event.h
intern/ghost/intern/GHOST_EventButton.h
intern/ghost/intern/GHOST_EventCursor.h
intern/ghost/intern/GHOST_EventDragnDrop.h
intern/ghost/intern/GHOST_EventKey.h
intern/ghost/intern/GHOST_EventManager.cpp
intern/ghost/intern/GHOST_EventManager.h
intern/ghost/intern/GHOST_EventPrinter.h
intern/ghost/intern/GHOST_EventString.h
intern/ghost/intern/GHOST_EventTrackpad.h
intern/ghost/intern/GHOST_EventWheel.h
intern/ghost/intern/GHOST_ISystem.cpp
intern/ghost/intern/GHOST_ISystemPaths.cpp
intern/ghost/intern/GHOST_ModifierKeys.cpp
intern/ghost/intern/GHOST_ModifierKeys.h
intern/ghost/intern/GHOST_System.h
intern/ghost/intern/GHOST_SystemCarbon.cpp
intern/ghost/intern/GHOST_SystemCarbon.h
intern/ghost/intern/GHOST_SystemCocoa.h
intern/ghost/intern/GHOST_SystemCocoa.mm
intern/ghost/intern/GHOST_SystemPaths.h
intern/ghost/intern/GHOST_SystemPathsCarbon.h
intern/ghost/intern/GHOST_SystemPathsCocoa.h
intern/ghost/intern/GHOST_SystemPathsWin32.h
intern/ghost/intern/GHOST_SystemPathsX11.h
intern/ghost/intern/GHOST_SystemWin32.h
intern/ghost/intern/GHOST_SystemX11.cpp
intern/ghost/intern/GHOST_SystemX11.h
intern/ghost/intern/GHOST_TimerManager.cpp
intern/ghost/intern/GHOST_TimerManager.h
intern/ghost/intern/GHOST_TimerTask.h
intern/ghost/intern/GHOST_Window.cpp
intern/ghost/intern/GHOST_Window.h
intern/ghost/intern/GHOST_WindowCarbon.cpp
intern/ghost/intern/GHOST_WindowCarbon.h
intern/ghost/intern/GHOST_WindowCocoa.h
intern/ghost/intern/GHOST_WindowCocoa.mm
intern/ghost/intern/GHOST_WindowManager.cpp
intern/ghost/intern/GHOST_WindowManager.h
intern/ghost/intern/GHOST_WindowWin32.cpp
intern/ghost/intern/GHOST_WindowWin32.h
intern/ghost/intern/GHOST_WindowX11.cpp
intern/ghost/intern/GHOST_WindowX11.h
intern/ghost/test/gears/GHOST_C-Test.c
intern/ghost/test/gears/GHOST_Test.cpp
source/blender/blenkernel/BKE_object_deform.h
source/blender/bmesh/bmesh.h
source/blender/bmesh/intern/bmesh_core.c
source/blender/bmesh/operators/bmo_subdivide.c
source/blender/compositor/COM_compositor.h
source/blender/compositor/intern/COM_ExecutionSystemHelper.h
source/blender/compositor/operations/COM_RenderLayersImageProg.h
source/blender/editors/io/io_collada.h
source/blender/editors/io/io_ops.h
source/blender/imbuf/intern/imbuf_cocoa.m
source/gameengine/Ketsji/KX_PythonMain.cpp

index 3e9f670..6aa4f87 100644 (file)
@@ -22,7 +22,7 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
-/** \file audaspace/intern/AUD_Reference.cpp
+/** \file audaspace/intern/AUD_ReferenceHandler.cpp
  *  \ingroup audaspaceintern
  */
 
index ef63c57..ba5d9ee 100644 (file)
@@ -45,10 +45,10 @@ class GHOST_IWindow;
  * Use the getType() method to retrieve the type of event and the getData() 
  * method to get the event data out. Using the event type you can cast the 
  * event data to the correct event dat structure.
- * @see GHOST_IEventConsumer#processEvent
- * @see GHOST_TEventType
- * @author     Maarten Gribnau
- * @date       May 31, 2001
+ * \see GHOST_IEventConsumer#processEvent
+ * \see GHOST_TEventType
+ * \author     Maarten Gribnau
+ * \date       May 31, 2001
  */
 class GHOST_IEvent
 {
@@ -62,26 +62,26 @@ public:
 
        /**
         * Returns the event type.
-        * @return The event type.
+        * \return The event type.
         */
        virtual GHOST_TEventType getType() = 0;
 
        /**
         * Returns the time this event was generated.
-        * @return The event generation time.
+        * \return The event generation time.
         */
        virtual GHOST_TUns64 getTime() = 0;
 
        /**
         * Returns the window this event was generated on, 
         * or NULL if it is a 'system' event.
-        * @return The generating window.
+        * \return The generating window.
         */
        virtual GHOST_IWindow *getWindow() = 0;
        
        /**
         * Returns the event data.
-        * @return The event data.
+        * \return The event data.
         */
        virtual GHOST_TEventDataPtr getData() = 0;
        
index cfc4fae..5682d04 100644 (file)
@@ -41,9 +41,9 @@
  * processEvent() method. They should then be registered with the system that
  * they want to receive events. The system will call the processEvent() method
  * for every installed event consumer to pass events.
- * @see GHOST_ISystem#addEventConsumer
- * @author     Maarten Gribnau
- * @date       May 14, 2001
+ * \see GHOST_ISystem#addEventConsumer
+ * \author     Maarten Gribnau
+ * \date       May 14, 2001
  */
 class GHOST_IEventConsumer
 {
@@ -57,9 +57,9 @@ public:
 
        /**
         * This method is called by the system when it has events to dispatch.
-        * @see GHOST_ISystem#dispatchEvents
-        * @param       event   The event that can be handled or ignored.
-        * @return      Indication as to whether the event was handled.
+        * \see GHOST_ISystem#dispatchEvents
+        * \param       event   The event that can be handled or ignored.
+        * \return      Indication as to whether the event was handled.
         */
        virtual bool processEvent(GHOST_IEvent *event) = 0;
        
index 474e3e9..8aef81b 100644 (file)
@@ -136,27 +136,27 @@ class GHOST_IEventConsumer;
  *  -# Access to the state of the mouse buttons and the keyboard.
  *  -# Menus for windows with events generated when they are accessed (this is
  *     work in progress).
- * @author     Maarten Gribnau
- * @date       May 30, 2001
+ * \author     Maarten Gribnau
+ * \date       May 30, 2001
  */
 class GHOST_ISystem
 {
 public:
        /**
         * Creates the one and only system.
-        * @return An indication of success.
+        * \return An indication of success.
         */
        static GHOST_TSuccess createSystem();
 
        /**
         * Disposes the one and only system.
-        * @return An indication of success.
+        * \return An indication of success.
         */
        static GHOST_TSuccess disposeSystem();
 
        /**
         * Returns a pointer to the one and only system (nil if it hasn't been created).
-        * @return A pointer to the system.
+        * \return A pointer to the system.
         */
        static GHOST_ISystem *getSystem();
 
@@ -184,7 +184,7 @@ public:
         * Returns the system time.
         * Returns the number of milliseconds since the start of the system process.
         * Based on ANSI clock() routine.
-        * @return The number of milliseconds.
+        * \return The number of milliseconds.
         */
        virtual GHOST_TUns64 getMilliSeconds() const = 0;
 
@@ -192,11 +192,11 @@ public:
         * Installs a timer.
         * Note that, on most operating systems, messages need to be processed in order 
         * for the timer callbacks to be invoked.
-        * @param delay         The time to wait for the first call to the timerProc (in milliseconds)
-        * @param interval      The interval between calls to the timerProc (in milliseconds)
-        * @param timerProc     The callback invoked when the interval expires,
-        * @param userData      Placeholder for user data.
-        * @return A timer task (0 if timer task installation failed).
+        * \param delay         The time to wait for the first call to the timerProc (in milliseconds)
+        * \param interval      The interval between calls to the timerProc (in milliseconds)
+        * \param timerProc     The callback invoked when the interval expires,
+        * \param userData      Placeholder for user data.
+        * \return A timer task (0 if timer task installation failed).
         */
        virtual GHOST_ITimerTask *installTimer(GHOST_TUns64 delay,
                                               GHOST_TUns64 interval,
@@ -205,8 +205,8 @@ public:
 
        /**
         * Removes a timer.
-        * @param timerTask Timer task to be removed.
-        * @return Indication of success.
+        * \param timerTask Timer task to be removed.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask) = 0;
 
@@ -216,13 +216,13 @@ public:
 
        /**
         * Returns the number of displays on this system.
-        * @return The number of displays.
+        * \return The number of displays.
         */
        virtual GHOST_TUns8 getNumDisplays() const = 0;
 
        /**
         * Returns the dimensions of the main display on this system.
-        * @return The dimension of the main display.
+        * \return The dimension of the main display.
         */
        virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const = 0;
        
@@ -230,17 +230,17 @@ public:
         * Create a new window.
         * The new window is added to the list of windows managed. 
         * Never explicitly delete the window, use disposeWindow() instead.
-        * @param       title                   The name of the window (displayed in the title bar of the window if the OS supports it).
-        * @param       left                    The coordinate of the left edge of the window.
-        * @param       top                             The coordinate of the top edge of the window.
-        * @param       width                   The width the window.
-        * @param       height                  The height the window.
-        * @param       state                   The state of the window when opened.
-        * @param       type                    The type of drawing context installed in this window.
-        * @param       stereoVisual    Create a stereo visual for quad buffered stereo.
-        * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
-        * @param       parentWindow    Parent (embedder) window
-        * @return      The new window (or 0 if creation failed).
+        * \param       title                   The name of the window (displayed in the title bar of the window if the OS supports it).
+        * \param       left                    The coordinate of the left edge of the window.
+        * \param       top                             The coordinate of the top edge of the window.
+        * \param       width                   The width the window.
+        * \param       height                  The height the window.
+        * \param       state                   The state of the window when opened.
+        * \param       type                    The type of drawing context installed in this window.
+        * \param       stereoVisual    Create a stereo visual for quad buffered stereo.
+        * \param       numOfAASamples  Number of samples used for AA (zero if no AA)
+        * \param       parentWindow    Parent (embedder) window
+        * \return      The new window (or 0 if creation failed).
         */
        virtual GHOST_IWindow *createWindow(
            const STR_String& title,
@@ -252,46 +252,46 @@ public:
 
        /**
         * Dispose a window.
-        * @param       window Pointer to the window to be disposed.
-        * @return      Indication of success.
+        * \param       window Pointer to the window to be disposed.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess disposeWindow(GHOST_IWindow *window) = 0;
 
        /**
         * Returns whether a window is valid.
-        * @param       window Pointer to the window to be checked.
-        * @return      Indication of validity.
+        * \param       window Pointer to the window to be checked.
+        * \return      Indication of validity.
         */
        virtual bool validWindow(GHOST_IWindow *window) = 0;
 
        /**
         * Begins full screen mode.
-        * @param setting       The new setting of the display.
-        * @param window        Window displayed in full screen.
+        * \param setting       The new setting of the display.
+        * \param window        Window displayed in full screen.
         *                                      This window is invalid after full screen has been ended.
-        * @return      Indication of success.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow **window,
                                               const bool stereoVisual, const GHOST_TUns16 numOfAASamples = 0) = 0;
        
        /**
         * Updates the resolution while in fullscreen mode.
-        * @param setting       The new setting of the display.
-        * @param window        Window displayed in full screen.
+        * \param setting       The new setting of the display.
+        * \param window        Window displayed in full screen.
         *
-        * @return      Indication of success.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess updateFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow **window) = 0;
 
        /**
         * Ends full screen mode.
-        * @return      Indication of success.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess endFullScreen(void) = 0;
 
        /**
         * Returns current full screen mode status.
-        * @return The current status.
+        * \return The current status.
         */
        virtual bool getFullScreen(void) = 0;
 
@@ -301,28 +301,28 @@ public:
 
        /**
         * Retrieves events from the system and stores them in the queue.
-        * @param waitForEvent Flag to wait for an event (or return immediately).
-        * @return Indication of the presence of events.
+        * \param waitForEvent Flag to wait for an event (or return immediately).
+        * \return Indication of the presence of events.
         */
        virtual bool processEvents(bool waitForEvent) = 0;
        
        /**
         * Retrieves events from the queue and send them to the event consumers.
-        * @return Indication of the presence of events.
+        * \return Indication of the presence of events.
         */
        virtual bool dispatchEvents() = 0;
 
        /**
         * Adds the given event consumer to our list.
-        * @param consumer The event consumer to add.
-        * @return Indication of success.
+        * \param consumer The event consumer to add.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer) = 0;
 
        /**
         * Removes the given event consumer to our list.
-        * @param consumer The event consumer to remove.
-        * @return Indication of success.
+        * \param consumer The event consumer to remove.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer) = 0;
 
@@ -332,18 +332,18 @@ public:
 
        /**
         * Returns the current location of the cursor (location in screen coordinates)
-        * @param x                     The x-coordinate of the cursor.
-        * @param y                     The y-coordinate of the cursor.
-        * @return                      Indication of success.
+        * \param x                     The x-coordinate of the cursor.
+        * \param y                     The y-coordinate of the cursor.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const = 0;
 
        /**
         * Updates the location of the cursor (location in screen coordinates).
         * Not all operating systems allow the cursor to be moved (without the input device being moved).
-        * @param x                     The x-coordinate of the cursor.
-        * @param y                     The y-coordinate of the cursor.
-        * @return                      Indication of success.
+        * \param x                     The x-coordinate of the cursor.
+        * \param y                     The y-coordinate of the cursor.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) = 0;
 
@@ -353,28 +353,29 @@ public:
 
        /**
         * Returns the state of a modifier key (ouside the message queue).
-        * @param mask          The modifier key state to retrieve.
-        * @param isDown        The state of a modifier key (true == pressed).
-        * @return                      Indication of success.
+        * \param mask          The modifier key state to retrieve.
+        * \param isDown        The state of a modifier key (true == pressed).
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const = 0;
 
        /**
         * Returns the state of a mouse button (ouside the message queue).
-        * @param mask          The button state to retrieve.
-        * @param isDown        Button state.
-        * @return                      Indication of success.
+        * \param mask          The button state to retrieve.
+        * \param isDown        Button state.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const = 0;
 
        /**
         * Toggles console
-        * @action      0 - Hides
-        *                      1 - Shows
-        *                      2 - Toggles
-        *                      3 - Hides if it runs not from  command line
-        *                      * - Does nothing
-        * @return current status (1 -visible, 0 - hidden)
+        * \param action
+        * - 0: Hides
+        * - 1: Shows
+        * - 2: Toggles
+        * - 3: Hides if it runs not from  command line
+        * - *: Does nothing
+        * \return current status (1 -visible, 0 - hidden)
         */
        virtual int toggleConsole(int action) = 0;
        
@@ -384,7 +385,7 @@ public:
        
        /**
         * Returns the selection buffer
-        * @return Returns "unsinged char" from X11 XA_CUT_BUFFER0 buffer
+        * \return Returns "unsinged char" from X11 XA_CUT_BUFFER0 buffer
         *
         */
        virtual GHOST_TUns8 *getClipboard(bool selection) const = 0;
@@ -402,13 +403,13 @@ public:
 protected:
        /**
         * Initialize the system.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess init() = 0;
 
        /**
         * Shut the system down.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess exit() = 0;
 
index 1ba4cea..8f81a22 100644 (file)
@@ -38,19 +38,19 @@ class GHOST_ISystemPaths
 public:
        /**
         * Creates the one and only system.
-        * @return An indication of success.
+        * \return An indication of success.
         */
        static GHOST_TSuccess create();
 
        /**
         * Disposes the one and only system.
-        * @return An indication of success.
+        * \return An indication of success.
         */
        static GHOST_TSuccess dispose();
 
        /**
         * Returns a pointer to the one and only system (nil if it hasn't been created).
-        * @return A pointer to the system.
+        * \return A pointer to the system.
         */
        static GHOST_ISystemPaths *get();
 
@@ -73,20 +73,20 @@ public:
        /**
         * Determine the base dir in which shared resources are located. It will first try to use
         * "unpack and run" path, then look for properly installed path, including versioning.
-        * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
+        * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
         */
        virtual const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const = 0;
 
        /**
         * Determine the base dir in which user configuration is stored, including versioning.
         * If needed, it will create the base directory.
-        * @return Unsigned char string pointing to user dir (eg ~/.blender/).
+        * \return Unsigned char string pointing to user dir (eg ~/.blender/).
         */
        virtual const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const = 0;
 
        /**
         * Determine the directory of the current binary
-        * @return Unsigned char string pointing to the binary dir
+        * \return Unsigned char string pointing to the binary dir
         */
        virtual const GHOST_TUns8 *getBinaryDir() const = 0;
 
index 08c4890..fcd42db 100644 (file)
  * <br>
  * Note that GHOST processes timers in the UI thread. You should ask GHOST 
  * process messages in order for the timer-callbacks to be called.
- * @see GHOST_ISystem#installTimer
- * @see GHOST_TimerProcPtr
- * @author     Maarten Gribnau
- * @date       May 31, 2001
+ * \see GHOST_ISystem#installTimer
+ * \see GHOST_TimerProcPtr
+ * \author     Maarten Gribnau
+ * \date       May 31, 2001
  */
 class GHOST_ITimerTask
 {
@@ -62,25 +62,25 @@ public:
 
        /**
         * Returns the timer callback.
-        * @return The timer callback.
+        * \return The timer callback.
         */
        virtual GHOST_TimerProcPtr getTimerProc() const = 0;
 
        /**
         * Changes the timer callback.
-        * @param timerProc The timer callback.
+        * \param timerProc The timer callback.
         */
        virtual void setTimerProc(const GHOST_TimerProcPtr timerProc) = 0;
 
        /**
         * Returns the timer user data.
-        * @return The timer user data.
+        * \return The timer user data.
         */
        virtual GHOST_TUserDataPtr getUserData() const = 0;
        
        /**
         * Changes the time user data.
-        * @param data The timer user data.
+        * \param data The timer user data.
         */
        virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
 
index b606294..a1a1acf 100644 (file)
@@ -43,7 +43,7 @@
  *
  * You can create a window with the system's GHOST_ISystem::createWindow 
  * method.
- * @see GHOST_ISystem#createWindow
+ * \see GHOST_ISystem#createWindow
  *
  * There are two coordinate systems:
  * <ul>
@@ -53,8 +53,8 @@
  * is the area that is drawable by the application (excluding title bars etc.).
  * </li> 
  * </ul>
- * @author     Maarten Gribnau
- * @date       May 31, 2001
+ * \author     Maarten Gribnau
+ * \date       May 31, 2001
  */
 class GHOST_IWindow
 {
@@ -68,89 +68,89 @@ public:
 
        /**
         * Returns indication as to whether the window is valid.
-        * @return The validity of the window.
+        * \return The validity of the window.
         */
        virtual bool getValid() const = 0;
 
        /**
         * Returns the associated OS object/handle
-        * @return The associated OS object/handle
+        * \return The associated OS object/handle
         */
        virtual void *getOSWindow() const = 0;
 
        /**
         * Returns the type of drawing context used in this window.
-        * @return The current type of drawing context.
+        * \return The current type of drawing context.
         */
        virtual GHOST_TDrawingContextType getDrawingContextType() = 0;
 
        /**
         * Tries to install a rendering context in this window.
-        * @param type  The type of rendering context installed.
-        * @return Indication as to whether installation has succeeded.
+        * \param type  The type of rendering context installed.
+        * \return Indication as to whether installation has succeeded.
         */
        virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type) = 0;
 
        /**
         * Sets the title displayed in the title bar.
-        * @param title The title to display in the title bar.
+        * \param title The title to display in the title bar.
         */
        virtual void setTitle(const STR_String& title) = 0;
 
        /**
         * Returns the title displayed in the title bar.
-        * @param title The title displayed in the title bar.
+        * \param title The title displayed in the title bar.
         */
        virtual void getTitle(STR_String& title) const = 0;
 
        /**
         * Returns the window rectangle dimensions.
         * These are screen coordinates.
-        * @param bounds The bounding rectangle of the window.
+        * \param bounds The bounding rectangle of the window.
         */
        virtual void getWindowBounds(GHOST_Rect& bounds) const = 0;
        
        /**
         * Returns the client rectangle dimensions.
         * The left and top members of the rectangle are always zero.
-        * @param bounds The bounding rectangle of the client area of the window.
+        * \param bounds The bounding rectangle of the client area of the window.
         */
        virtual void getClientBounds(GHOST_Rect& bounds) const = 0;
 
        /**
         * Resizes client rectangle width.
-        * @param width The new width of the client area of the window.
+        * \param width The new width of the client area of the window.
         */
        virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width) = 0;
 
        /**
         * Resizes client rectangle height.
-        * @param height The new height of the client area of the window.
+        * \param height The new height of the client area of the window.
         */
        virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height) = 0;
 
        /**
         * Resizes client rectangle.
-        * @param width         The new width of the client area of the window.
-        * @param height        The new height of the client area of the window.
+        * \param width         The new width of the client area of the window.
+        * \param height        The new height of the client area of the window.
         */
        virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height) = 0;
 
        /**
         * Converts a point in screen coordinates to client rectangle coordinates
-        * @param inX   The x-coordinate on the screen.
-        * @param inY   The y-coordinate on the screen.
-        * @param outX  The x-coordinate in the client rectangle.
-        * @param outY  The y-coordinate in the client rectangle.
+        * \param inX   The x-coordinate on the screen.
+        * \param inY   The y-coordinate on the screen.
+        * \param outX  The x-coordinate in the client rectangle.
+        * \param outY  The y-coordinate in the client rectangle.
         */
        virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
 
        /**
         * Converts a point in screen coordinates to client rectangle coordinates
-        * @param inX   The x-coordinate in the client rectangle.
-        * @param inY   The y-coordinate in the client rectangle.
-        * @param outX  The x-coordinate on the screen.
-        * @param outY  The y-coordinate on the screen.
+        * \param inX   The x-coordinate in the client rectangle.
+        * \param inY   The y-coordinate in the client rectangle.
+        * \param outX  The x-coordinate on the screen.
+        * \param outY  The y-coordinate on the screen.
         */
        virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const = 0;
 
@@ -167,70 +167,70 @@ public:
        
        /**
         * Returns the state of the window (normal, minimized, maximized).
-        * @return The state of the window.
+        * \return The state of the window.
         */
        virtual GHOST_TWindowState getState() const = 0;
 
        /**
         * Sets the state of the window (normal, minimized, maximized).
-        * @param state The state of the window.
-        * @return Indication of success.
+        * \param state The state of the window.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setState(GHOST_TWindowState state) = 0;
 
        /**
         * Sets the window "modified" status, indicating unsaved changes
-        * @param isUnsavedChanges Unsaved changes or not
-        * @return Indication of success.
+        * \param isUnsavedChanges Unsaved changes or not
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges) = 0;
        
        /**
         * Gets the window "modified" status, indicating unsaved changes
-        * @return True if there are unsaved changes
+        * \return True if there are unsaved changes
         */
        virtual bool getModifiedState() = 0;
        
        /**
         * Sets the order of the window (bottom, top).
-        * @param order The order of the window.
-        * @return Indication of success.
+        * \param order The order of the window.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order) = 0;
 
        /**
         * Swaps front and back buffers of a window.
-        * @return      A boolean success indicator.
+        * \return      A boolean success indicator.
         */
        virtual GHOST_TSuccess swapBuffers() = 0;
 
        /**
         * Activates the drawing context of this window.
-        * @return      A boolean success indicator.
+        * \return      A boolean success indicator.
         */
        virtual GHOST_TSuccess activateDrawingContext() = 0;
 
        /**
         * Invalidates the contents of this window.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess invalidate() = 0;
        
        /**
         * Returns the window user data.
-        * @return The window user data.
+        * \return The window user data.
         */
        virtual GHOST_TUserDataPtr getUserData() const = 0;
        
        /**
         * Changes the window user data.
-        * @param data The window user data.
+        * \param data The window user data.
         */
        virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
        
        /**
         * Returns the tablet data (pressure etc).
-        * @return The tablet data (pressure etc).
+        * \return The tablet data (pressure etc).
         */
        virtual const GHOST_TabletData *GetTabletData() = 0;
        
@@ -240,7 +240,7 @@ public:
        
        /**
         * Sets the progress bar value displayed in the window/application icon
-        * @param progress The progress %
+        * \param progress The progress %
         */
        virtual GHOST_TSuccess setProgressBar(float progress) = 0;
        
@@ -255,24 +255,24 @@ public:
 
        /**
         * Returns the current cursor shape.
-        * @return      The current cursor shape.
+        * \return      The current cursor shape.
         */
        virtual GHOST_TStandardCursor getCursorShape() const = 0;
 
        /**
         * Set the shape of the cursor.
-        * @param       cursor  The new cursor shape type id.
-        * @return      Indication of success.
+        * \param       cursor  The new cursor shape type id.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape) = 0;
 
        /**
         * Set the shape of the cursor to a custom cursor.
-        * @param       bitmap  The bitmap data for the cursor.
-        * @param       mask    The mask data for the cursor.
-        * @param       hotX    The X coordinate of the cursor hotspot.
-        * @param       hotY    The Y coordinate of the cursor hotspot.
-        * @return      Indication of success.
+        * \param       bitmap  The bitmap data for the cursor.
+        * \param       mask    The mask data for the cursor.
+        * \param       hotX    The X coordinate of the cursor hotspot.
+        * \param       hotY    The Y coordinate of the cursor hotspot.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], 
                                                    GHOST_TUns8 mask[16][2],
@@ -287,21 +287,21 @@ public:
 
        /**
         * Returns the visibility state of the cursor.
-        * @return      The visibility state of the cursor.
+        * \return      The visibility state of the cursor.
         */
        virtual bool getCursorVisibility() const = 0;
 
        /**
         * Shows or hides the cursor.
-        * @param       visible The new visibility state of the cursor.
-        * @return      Indication of success.
+        * \param       visible The new visibility state of the cursor.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess setCursorVisibility(bool visible) = 0;
 
        /**
         * Grabs the cursor for a modal operation.
-        * @param       grab The new grab state of the cursor.
-        * @return      Indication of success.
+        * \param       grab The new grab state of the cursor.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds) { return GHOST_kSuccess; }
 
index a037f2e..5af3ada 100644 (file)
@@ -43,33 +43,33 @@ GHOST_DECLARE_HANDLE(GHOST_SystemPathsHandle);
 
 /**
  * Creates the one and only instance of the system path access.
- * @return An indication of success.
+ * \return An indication of success.
  */
 extern GHOST_TSuccess GHOST_CreateSystemPaths(void);
 
 /**
  * Disposes the one and only system.
- * @return An indication of success.
+ * \return An indication of success.
  */
 extern GHOST_TSuccess GHOST_DisposeSystemPaths(void);
 
 /**
  * Determine the base dir in which shared resources are located. It will first try to use
  * "unpack and run" path, then look for properly installed path, including versioning.
- * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
+ * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
  */
 extern const GHOST_TUns8 *GHOST_getSystemDir(int version, const char *versionstr);
 
 /**
  * Determine the base dir in which user configuration is stored, including versioning.
- * @return Unsigned char string pointing to user dir (eg ~).
+ * \return Unsigned char string pointing to user dir (eg ~).
  */
 extern const GHOST_TUns8 *GHOST_getUserDir(int version, const char *versionstr);
 
 
 /**
  * Determine the dir in which the binary file is found.
- * @return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
+ * \return Unsigned char string pointing to binary dir (eg ~/usr/local/bin/).
  */
 extern const GHOST_TUns8 *GHOST_getBinaryDir(void);
 
index 745e402..e52d6a7 100644 (file)
@@ -41,8 +41,8 @@
  * The four extreme coordinates are stored as left, top, right and bottom.
  * To be valid, a rectangle should have a left coordinate smaller than or equal to right.
  * To be valid, a rectangle should have a top coordinate smaller than or equal to bottom.
- * @author     Maarten Gribnau
- * @date       May 10, 2001
+ * \author     Maarten Gribnau
+ * \date       May 10, 2001
  */
 
 class GHOST_Rect {
@@ -50,10 +50,10 @@ public:
 
        /**
         * Constructs a rectangle with the given values.
-        * @param       l       requested left coordinate of the rectangle
-        * @param       t       requested top coordinate of the rectangle
-        * @param       r       requested right coordinate of the rectangle
-        * @param       b       requested bottom coordinate of the rectangle
+        * \param       l       requested left coordinate of the rectangle
+        * \param       t       requested top coordinate of the rectangle
+        * \param       r       requested right coordinate of the rectangle
+        * \param       b       requested bottom coordinate of the rectangle
         */
        GHOST_Rect(GHOST_TInt32 l = 0, GHOST_TInt32 t = 0, GHOST_TInt32 r = 0, GHOST_TInt32 b = 0)
                : m_l(l), m_t(t), m_r(r), m_b(b)
@@ -61,7 +61,7 @@ public:
 
        /**
         * Copy constructor.
-        * @param       r       rectangle to copy
+        * \param       r       rectangle to copy
         */
        GHOST_Rect(const GHOST_Rect& r)
                : m_l(r.m_l), m_t(r.m_t), m_r(r.m_r), m_b(r.m_b)
@@ -75,88 +75,88 @@ public:
 
        /**
         * Access to rectangle width.
-        * @return      width of the rectangle
+        * \return      width of the rectangle
         */
        virtual inline GHOST_TInt32 getWidth() const;
 
        /**
         * Access to rectangle height.
-        * @return      height of the rectangle
+        * \return      height of the rectangle
         */
        virtual inline GHOST_TInt32 getHeight() const;
 
        /**
         * Sets all members of the rectangle.
-        * @param       l       requested left coordinate of the rectangle
-        * @param       t       requested top coordinate of the rectangle
-        * @param       r       requested right coordinate of the rectangle
-        * @param       b       requested bottom coordinate of the rectangle
+        * \param       l       requested left coordinate of the rectangle
+        * \param       t       requested top coordinate of the rectangle
+        * \param       r       requested right coordinate of the rectangle
+        * \param       b       requested bottom coordinate of the rectangle
         */
        virtual inline void set(GHOST_TInt32 l, GHOST_TInt32 t, GHOST_TInt32 r, GHOST_TInt32 b);
 
        /**
         * Returns whether this rectangle is empty.
         * Empty rectangles are rectangles that have width==0 and/or height==0.
-        * @return      boolean value (true==empty rectangle)
+        * \return      boolean value (true==empty rectangle)
         */
        virtual inline bool isEmpty() const;
 
        /**
         * Returns whether this rectangle is valid.
         * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty rectangles are valid.
-        * @return      boolean value (true==valid rectangle)
+        * \return      boolean value (true==valid rectangle)
         */
        virtual inline bool isValid() const;
 
        /**
         * Grows (or shrinks the rectangle).
         * The method avoids negative insets making the rectangle invalid
-        * @param       i       The amount of offset given to each extreme (negative values shrink the rectangle).
+        * \param       i       The amount of offset given to each extreme (negative values shrink the rectangle).
         */
        virtual void inset(GHOST_TInt32 i);
 
        /**
         * Does a union of the rectangle given and this rectangle.
         * The result is stored in this rectangle.
-        * @param       r       The rectangle that is input for the union operation.
+        * \param       r       The rectangle that is input for the union operation.
         */
        virtual inline void unionRect(const GHOST_Rect& r);
 
        /**
         * Grows the rectangle to included a point.
-        * @param       x       The x-coordinate of the point.
-        * @param       y       The y-coordinate of the point.
+        * \param       x       The x-coordinate of the point.
+        * \param       y       The y-coordinate of the point.
         */
        virtual inline void unionPoint(GHOST_TInt32 x, GHOST_TInt32 y);
 
        /**
         * Grows the rectangle to included a point.
-        * @param       x       The x-coordinate of the point.
-        * @param       y       The y-coordinate of the point.
+        * \param       x       The x-coordinate of the point.
+        * \param       y       The y-coordinate of the point.
         */
        virtual inline void wrapPoint(GHOST_TInt32 &x, GHOST_TInt32 &y, GHOST_TInt32 ofs);
 
        /**
         * Returns whether the point is inside this rectangle.
         * Point on the boundary is considered inside.
-        * @param x     x-coordinate of point to test.
-        * @param y y-coordinate of point to test.
-        * @return boolean value (true if point is inside).
+        * \param x     x-coordinate of point to test.
+        * \param y y-coordinate of point to test.
+        * \return boolean value (true if point is inside).
         */
        virtual inline bool isInside(GHOST_TInt32 x, GHOST_TInt32 y) const;
 
        /**
         * Returns whether the rectangle is inside this rectangle.
-        * @param       r       rectangle to test.
-        * @return      visibility (not, partially or fully visible).
+        * \param       r       rectangle to test.
+        * \return      visibility (not, partially or fully visible).
         */
        virtual GHOST_TVisibility getVisibility(GHOST_Rect& r) const;
 
        /**
         * Sets rectangle members.
         * Sets rectangle members such that it is centered at the given location.
-        * @param       cx      requested center x-coordinate of the rectangle
-        * @param       cy      requested center y-coordinate of the rectangle
+        * \param       cx      requested center x-coordinate of the rectangle
+        * \param       cy      requested center y-coordinate of the rectangle
         */
        virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy);
 
@@ -164,10 +164,10 @@ public:
         * Sets rectangle members.
         * Sets rectangle members such that it is centered at the given location,
         * with the width requested.
-        * @param       cx      requested center x-coordinate of the rectangle
-        * @param       cy      requested center y-coordinate of the rectangle
-        * @param       w       requested width of the rectangle
-        * @param       h       requested height of the rectangle
+        * \param       cx      requested center x-coordinate of the rectangle
+        * \param       cy      requested center y-coordinate of the rectangle
+        * \param       w       requested width of the rectangle
+        * \param       h       requested height of the rectangle
         */
        virtual void setCenter(GHOST_TInt32 cx, GHOST_TInt32 cy, GHOST_TInt32 w, GHOST_TInt32 h);
 
@@ -175,8 +175,8 @@ public:
         * Clips a rectangle.
         * Updates the rectangle given such that it will fit within this one.
         * This can result in an empty rectangle.
-        * @param       r       the rectangle to clip
-        * @return      whether clipping has occurred
+        * \param       r       the rectangle to clip
+        * \return      whether clipping has occurred
         */
        virtual bool clip(GHOST_Rect& r) const;
 
index 4921acd..c6d364c 100644 (file)
@@ -507,8 +507,8 @@ typedef int GHOST_TEmbedderWindowID;
 
 /**
  * A timer task callback routine.
- * @param task The timer task object.
- * @param time The current time.
+ * \param task The timer task object.
+ * \param time The current time.
  */
 #ifdef __cplusplus
 class GHOST_ITimerTask;
index edcf010..6b0d74e 100644 (file)
@@ -39,8 +39,8 @@
 /**
  * This struct stores the state of the mouse buttons.
  * Buttons can be set using button masks. 
- * @author     Maarten Gribnau
- * @date       May 15, 2001
+ * \author     Maarten Gribnau
+ * \date       May 15, 2001
  */
 struct GHOST_Buttons {
        /**
@@ -52,15 +52,15 @@ struct GHOST_Buttons {
 
        /**
         * Returns the state of a single button.
-        * @param mask Key button to return.
-        * @return The state of the button (pressed == true).
+        * \param mask Key button to return.
+        * \return The state of the button (pressed == true).
         */
        virtual bool get(GHOST_TButtonMask mask) const;
 
        /**
         * Updates the state of a single button.
-        * @param mask Button state to update.
-        * @param down The new state of the button.
+        * \param mask Button state to update.
+        * \param down The new state of the button.
         */
        virtual void set(GHOST_TButtonMask mask, bool down);
 
index 4712156..9d20a62 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       October 25, 2001
+ * \author     Maarten Gribnau
+ * \date       October 25, 2001
  */
 
 #include "GHOST_Debug.h"
index e13a56c..770ebdc 100644 (file)
 /**
  * Event consumer that will forward events to a call-back routine.
  * Especially useful for the C-API.
- * @author     Maarten Gribnau
- * @date       October 25, 2001
+ * \author     Maarten Gribnau
+ * \date       October 25, 2001
  */
 class GHOST_CallbackEventConsumer : public GHOST_IEventConsumer
 {
 public:
        /**
         * Constructor.
-        * @param       eventCallback   The call-back routine invoked.
-        * @param       userData                The data passed back though the call-back routine.
+        * \param       eventCallback   The call-back routine invoked.
+        * \param       userData                The data passed back though the call-back routine.
         */
        GHOST_CallbackEventConsumer(
            GHOST_EventCallbackProcPtr eventCallback,
@@ -63,8 +63,8 @@ public:
 
        /**
         * This method is called by an event producer when an event is available.
-        * @param event The event that can be handled or ignored.
-        * @return Indication as to whether the event was handled.
+        * \param event The event that can be handled or ignored.
+        * \return Indication as to whether the event was handled.
         */
        virtual bool processEvent(GHOST_IEvent *event);
 
index 380fb81..7ca4c81 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       September 21, 2001
+ * \author     Maarten Gribnau
+ * \date       September 21, 2001
  */
 
 #include "GHOST_DisplayManager.h"
index 7893f09..7dc0cf2 100644 (file)
@@ -39,8 +39,8 @@
 
 /**
  * Manages system displays  (platform independent implementation).
- * @author     Maarten Gribnau
- * @date       September 21, 2001
+ * \author     Maarten Gribnau
+ * \date       September 21, 2001
  */
 class GHOST_DisplayManager
 {
@@ -58,32 +58,32 @@ public:
 
        /**
         * Initializes the list with devices and settings.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess initialize(void);
 
        /**
         * Returns the number of display devices on this system.
-        * @param numDisplays The number of displays on this system.
-        * @return Indication of success.
+        * \param numDisplays The number of displays on this system.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) const;
 
        /**
         * Returns the number of display settings for this display device.
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param numSettings The number of settings of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param numSettings The number of settings of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display,
                                                     GHOST_TInt32& numSettings) const;
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param index   The setting index to be returned.
-        * @param setting The setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param index   The setting index to be returned.
+        * \param setting The setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display,
                                                 GHOST_TInt32 index,
@@ -91,9 +91,9 @@ public:
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The current setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The current setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display,
                                                        GHOST_DisplaySetting& setting) const;
@@ -102,9 +102,9 @@ public:
         * Changes the current setting for this display device.
         * The setting given to this method is matched againts the available diplay settings.
         * The best match is activated (@see findMatch()).
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The setting of the display device to be matched and activated.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The setting of the display device to be matched and activated.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display,
                                                        const GHOST_DisplaySetting& setting);
@@ -114,10 +114,10 @@ protected:
 
        /**
         * Finds the best display settings match.
-        * @param display       The index of the display device.
-        * @param setting       The setting to match.
-        * @param match         The optimal display setting.
-        * @return Indication of success.
+        * \param display       The index of the display device.
+        * \param setting       The setting to match.
+        * \param match         The optimal display setting.
+        * \return Indication of success.
         */
        GHOST_TSuccess findMatch(GHOST_TUns8 display,
                                 const GHOST_DisplaySetting& setting,
@@ -125,7 +125,7 @@ protected:
 
        /**
         * Retrieves settings for each display device and stores them.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        GHOST_TSuccess initializeSettings(void);
        
index 21798ed..3f7d210 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       September 21, 2001
+ * \author     Maarten Gribnau
+ * \date       September 21, 2001
  */
 
 #include "GHOST_DisplayManagerCarbon.h"
index d9af12b..1ac6540 100644 (file)
@@ -44,9 +44,9 @@
 
 /**
  * Manages system displays  (Mac OSX/Carbon implementation).
- * @see GHOST_DisplayManager
- * @author     Maarten Gribnau
- * @date       September 21, 2001
+ * \see GHOST_DisplayManager
+ * \author     Maarten Gribnau
+ * \date       September 21, 2001
  */
 class GHOST_DisplayManagerCarbon : public GHOST_DisplayManager
 {
@@ -58,50 +58,50 @@ public:
 
        /**
         * Returns the number of display devices on this system.
-        * @param numDisplays The number of displays on this system.
-        * @return Indication of success.
+        * \param numDisplays The number of displays on this system.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) const;
 
        /**
         * Returns the number of display settings for this display device.
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The number of settings of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The number of settings of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param index   The setting index to be returned.
-        * @param setting The setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param index   The setting index to be returned.
+        * \param setting The setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The current setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The current setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
 
        /**
         * Changes the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The current setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The current setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
 
 protected:
        /**
         * Returns a value from a dictionary.
-        * @param       values  Dictionary to return value from.
-        * @param       key     Key to return value for.
-        * @return The value for this key.
+        * \param       values  Dictionary to return value from.
+        * \param       key     Key to return value for.
+        * \return The value for this key.
         */
        long getValue(CFDictionaryRef values, CFStringRef key) const;
        
index bf194ad..1f17b4d 100644 (file)
@@ -41,9 +41,9 @@
 
 /**
  * Manages system displays  (Mac OSX/Cocoa implementation).
- * @see GHOST_DisplayManager
- * @author     Maarten Gribnau
- * @date       September 21, 2001
+ * \see GHOST_DisplayManager
+ * \author     Maarten Gribnau
+ * \date       September 21, 2001
  */
 class GHOST_DisplayManagerCocoa : public GHOST_DisplayManager
 {
@@ -55,41 +55,41 @@ public:
 
        /**
         * Returns the number of display devices on this system.
-        * @param numDisplays The number of displays on this system.
-        * @return Indication of success.
+        * \param numDisplays The number of displays on this system.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) const;
 
        /**
         * Returns the number of display settings for this display device.
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The number of settings of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The number of settings of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param index   The setting index to be returned.
-        * @param setting The setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param index   The setting index to be returned.
+        * \param setting The setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The current setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The current setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
 
        /**
         * Changes the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The current setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The current setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
 
index 534274e..ced4cea 100644 (file)
@@ -42,8 +42,8 @@
 
 /**
  * Manages system displays  (WIN32 implementation).
- * @author     Maarten Gribnau
- * @date       September 21, 2001
+ * \author     Maarten Gribnau
+ * \date       September 21, 2001
  */
 class GHOST_DisplayManagerWin32 : public GHOST_DisplayManager
 {
@@ -55,41 +55,41 @@ public:
 
        /**
         * Returns the number of display devices on this system.
-        * @param numDisplays The number of displays on this system.
-        * @return Indication of success.
+        * \param numDisplays The number of displays on this system.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getNumDisplays(GHOST_TUns8& numDisplays) const;
 
        /**
         * Returns the number of display settings for this display device.
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The number of settings of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The number of settings of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param index   The setting index to be returned.
-        * @param setting The setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param index   The setting index to be returned.
+        * \param setting The setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getDisplaySetting(GHOST_TUns8 display, GHOST_TInt32 index, GHOST_DisplaySetting& setting) const;
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The current setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The current setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess getCurrentDisplaySetting(GHOST_TUns8 display, GHOST_DisplaySetting& setting) const;
 
        /**
         * Changes the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The current setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The current setting of the display device with this index.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setCurrentDisplaySetting(GHOST_TUns8 display, const GHOST_DisplaySetting& setting);
 
index 61b4578..66fd1e5 100644 (file)
@@ -40,8 +40,8 @@ class GHOST_SystemX11;
 
 /**
  * Manages system displays  (X11 implementation).
- * @author     Laurence Bourn
- * @date       October 26, 2001
+ * \author     Laurence Bourn
+ * \date       October 26, 2001
  */
 class GHOST_DisplayManagerX11 : public GHOST_DisplayManager
 {
@@ -55,8 +55,8 @@ public:
 
        /**
         * Returns the number of display devices on this system.
-        * @param numDisplays The number of displays on this system.
-        * @return Indication of success.
+        * \param numDisplays The number of displays on this system.
+        * \return Indication of success.
         */
        GHOST_TSuccess
        getNumDisplays(
@@ -65,9 +65,9 @@ public:
 
        /**
         * Returns the number of display settings for this display device.
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The number of settings of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The number of settings of the display device with this index.
+        * \return Indication of success.
         */
        GHOST_TSuccess
        getNumDisplaySettings(
@@ -77,10 +77,10 @@ public:
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param index   The setting index to be returned.
-        * @param setting The setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param index   The setting index to be returned.
+        * \param setting The setting of the display device with this index.
+        * \return Indication of success.
         */
        GHOST_TSuccess
        getDisplaySetting(
@@ -91,9 +91,9 @@ public:
 
        /**
         * Returns the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The current setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The current setting of the display device with this index.
+        * \return Indication of success.
         */
        GHOST_TSuccess
        getCurrentDisplaySetting(
@@ -103,9 +103,9 @@ public:
 
        /**
         * Changes the current setting for this display device. 
-        * @param display The index of the display to query with 0 <= display < getNumDisplays().
-        * @param setting The current setting of the display device with this index.
-        * @return Indication of success.
+        * \param display The index of the display to query with 0 <= display < getNumDisplays().
+        * \param setting The current setting of the display device with this index.
+        * \return Indication of success.
         */
        GHOST_TSuccess
        setCurrentDisplaySetting(
index 88a4032..f746a50 100644 (file)
@@ -80,8 +80,8 @@ public:
         * With the modifier keys, we want to distinguish left and right keys.
         * Sometimes this is not possible (Windows ME for instance). Then, we want
         * events generated for both keys.
-        * @param window        The window to register as drop target.
-        * @param system        The associated system.
+        * \param window        The window to register as drop target.
+        * \param system        The associated system.
         */
        GHOST_DropTargetWin32(GHOST_WindowWin32 *window, GHOST_SystemWin32 *system);
 
@@ -97,37 +97,37 @@ private:
 
        /**
         * Base the effect on those allowed by the dropsource.
-        * @param dwAllowed Drop sources allowed drop effect.
-        * @return The allowed drop effect.
+        * \param dwAllowed Drop sources allowed drop effect.
+        * \return The allowed drop effect.
         */
        DWORD allowedDropEffect(DWORD dwAllowed);
 
        /**
         * Query DataObject for the data types it supports.
-        * @param pDataObject Pointer to the DataObject.
-        * @return GHOST data type.
+        * \param pDataObject Pointer to the DataObject.
+        * \return GHOST data type.
         */
        GHOST_TDragnDropTypes getGhostType(IDataObject *pDataObject);
 
        /**
         * Get data to pass in event.
         * It checks the type and calls specific functions for each type.
-        * @param pDataObject Pointer to the DataObject.
-        * @return Pointer to data.
+        * \param pDataObject Pointer to the DataObject.
+        * \return Pointer to data.
         */
        void *getGhostData(IDataObject *pDataObject);
 
        /**
         * Allocate data as file array to pass in event.
-        * @param pDataObject Pointer to the DataObject.
-        * @return Pointer to data.
+        * \param pDataObject Pointer to the DataObject.
+        * \return Pointer to data.
         */
        void *getDropDataAsFilenames(IDataObject *pDataObject);
 
        /**
         * Allocate data as string to pass in event.
-        * @param pDataObject Pointer to the DataObject.
-        * @return Pointer to data.
+        * \param pDataObject Pointer to the DataObject.
+        * \return Pointer to data.
         */
        void *getDropDataAsString(IDataObject *pDataObject);
 
@@ -135,9 +135,9 @@ private:
         * Convert Unicode to ANSI, replacing unconvertable chars with '?'.
         * The ANSI codepage is the system default codepage, 
         * and can change from system to system.
-        * @param in LPCWSTR.
-        * @param out char *. Is set to NULL on failure.
-        * @return 0 on failure. Else the size of the string including '\0'.
+        * \param in LPCWSTR.
+        * \param out char *. Is set to NULL on failure.
+        * \return 0 on failure. Else the size of the string including '\0'.
         */
        int WideCharToANSI(LPCWSTR in, char * &out);
 
index 10d76bb..3fed579 100644 (file)
@@ -44,8 +44,8 @@ public:
        /**
         * Constructor
         *
-        * @param window        The window to register as drop target.
-        * @param system        The associated system.
+        * \param window        The window to register as drop target.
+        * \param system        The associated system.
         */
        GHOST_DropTargetX11(GHOST_WindowX11 *window, GHOST_SystemX11 *system);
 
@@ -62,10 +62,10 @@ public:
        /**
         * Get data to pass in event.
         * It checks the type and calls specific functions for each type.
-        * @param dropType - type of dropped entity.
-        * @param dropBuffer - buffer returned from source application
-        * @param dropBufferSize - size of returned buffer
-        * @return Pointer to data.
+        * \param dropType - type of dropped entity.
+        * \param dropBuffer - buffer returned from source application
+        * \param dropBufferSize - size of returned buffer
+        * \return Pointer to data.
         */
        void *getGhostData(Atom dropType, unsigned char *dropBuffer, int dropBufferSize);
 
@@ -84,24 +84,24 @@ private:
 
        /**
         * Get data to be passed to event from text/uri-list mime type
-        * @param dropBuffer - buffer returned from source application
-        * @param dropBufferSize - size of dropped buffer
-        * @return pointer to newly created GHOST data
+        * \param dropBuffer - buffer returned from source application
+        * \param dropBufferSize - size of dropped buffer
+        * \return pointer to newly created GHOST data
         */
        void *getURIListGhostData(unsigned char *dropBuffer, int dropBufferSize);
 
        /**
         * Decode URL (i.e. converts "file:///a%20b/test" to "file:///a b/test")
-        * @param decodedOut - buffer for decoded URL
-        * @param bufferSize - size of output buffer
-        * @param encodedIn - input encoded buffer to be decoded
+        * \param decodedOut - buffer for decoded URL
+        * \param bufferSize - size of output buffer
+        * \param encodedIn - input encoded buffer to be decoded
         */
        void UrlDecode(char *decodedOut, int bufferSize, const char *encodedIn);
 
        /**
         * Fully decode file URL (i.e. converts "file:///a%20b/test" to "/a b/test")
-        * @param fileUrl - file path URL to be fully decoded
-        * @return decoded file path (resutl shold be free-d)
+        * \param fileUrl - file path URL to be fully decoded
+        * \return decoded file path (resutl shold be free-d)
         */
        char *FileUrlDecode(char *fileUrl);
 
index 6e12a34..c9a51f2 100644 (file)
 
 /**
  * Base class for events received the operating system.
- * @author     Maarten Gribnau
- * @date       May 11, 2001
+ * \author     Maarten Gribnau
+ * \date       May 11, 2001
  */
 class GHOST_Event : public GHOST_IEvent
 {
 public:
        /**
         * Constructor.
-        * @param msec  The time this event was generated.
-        * @param type  The type of this event.
-        * @param window The generating window (or NULL if system event).
+        * \param msec  The time this event was generated.
+        * \param type  The type of this event.
+        * \param window The generating window (or NULL if system event).
         */
        GHOST_Event(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow *window)
                : m_type(type), m_time(msec), m_window(window), m_data(0)
@@ -57,7 +57,7 @@ public:
 
        /**
         * Returns the event type.
-        * @return The event type.
+        * \return The event type.
         */
        virtual GHOST_TEventType getType()
        { 
@@ -66,7 +66,7 @@ public:
 
        /**
         * Returns the time this event was generated.
-        * @return The event generation time.
+        * \return The event generation time.
         */
        virtual GHOST_TUns64 getTime()
        {
@@ -76,7 +76,7 @@ public:
        /**
         * Returns the window this event was generated on, 
         * or NULL if it is a 'system' event.
-        * @return The generating window.
+        * \return The generating window.
         */
        virtual GHOST_IWindow *getWindow()
        {
@@ -85,7 +85,7 @@ public:
 
        /**
         * Returns the event data.
-        * @return The event data.
+        * \return The event data.
         */
        virtual GHOST_TEventDataPtr getData()
        {
index 7ad840b..f88fe6e 100644 (file)
 
 /**
  * Mouse button event.
- * @author     Maarten Gribnau
- * @date       May 11, 2001
+ * \author     Maarten Gribnau
+ * \date       May 11, 2001
  */
 class GHOST_EventButton : public GHOST_Event
 {
 public:
        /**
         * Constructor.
-        * @param time          The time this event was generated.
-        * @param type          The type of this event.
-        * @param x                     The x-coordinate of the location the cursor was at at the time of the event.
-        * @param y                     The y-coordinate of the location the cursor was at at the time of the event.
-        * @param buttons       The state of the buttons  was at at the time of the event.
+        * \param time          The time this event was generated.
+        * \param type          The type of this event.
+        * \param x                     The x-coordinate of the location the cursor was at at the time of the event.
+        * \param y                     The y-coordinate of the location the cursor was at at the time of the event.
+        * \param buttons       The state of the buttons  was at at the time of the event.
         */
        GHOST_EventButton(GHOST_TUns64 time, GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask button)
                : GHOST_Event(time, type, window)
index 0ff703b..1c6f762 100644 (file)
 
 /**
  * Cursor event.
- * @author     Maarten Gribnau
- * @date       May 11, 2001
+ * \author     Maarten Gribnau
+ * \date       May 11, 2001
  */
 class GHOST_EventCursor : public GHOST_Event
 {
 public:
        /**
         * Constructor.
-        * @param msec          The time this event was generated.
-        * @param type          The type of this event.
-        * @param x                     The x-coordinate of the location the cursor was at at the time of the event.
-        * @param y                     The y-coordinate of the location the cursor was at at the time of the event.
+        * \param msec          The time this event was generated.
+        * \param type          The type of this event.
+        * \param x                     The x-coordinate of the location the cursor was at at the time of the event.
+        * \param y                     The y-coordinate of the location the cursor was at at the time of the event.
         */
        GHOST_EventCursor(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow *window, GHOST_TInt32 x, GHOST_TInt32 y)
                : GHOST_Event(msec, type, window)
index 1a05a4b..cef9bb0 100644 (file)
@@ -72,13 +72,13 @@ class GHOST_EventDragnDrop : public GHOST_Event
 public:
        /**
         * Constructor.
-        * @param time          The time this event was generated.
-        * @param type          The type of this event.
-        * @param dataType      The type of the drop candidate object
-        * @param window        The window where the event occurred
-        * @param x                     The x-coordinate of the location the cursor was at at the time of the event.
-        * @param y                     The y-coordinate of the location the cursor was at at the time of the event.
-        * @param data          The "content" dropped in the window
+        * \param time          The time this event was generated.
+        * \param type          The type of this event.
+        * \param dataType      The type of the drop candidate object
+        * \param window        The window where the event occurred
+        * \param x                     The x-coordinate of the location the cursor was at at the time of the event.
+        * \param y                     The y-coordinate of the location the cursor was at at the time of the event.
+        * \param data          The "content" dropped in the window
         */
        GHOST_EventDragnDrop(GHOST_TUns64 time,
                             GHOST_TEventType type,
index 6681757..54e38c0 100644 (file)
 
 /**
  * Key event.
- * @author     Maarten Gribnau
- * @date       May 11, 2001
+ * \author     Maarten Gribnau
+ * \date       May 11, 2001
  */
 class GHOST_EventKey : public GHOST_Event
 {
 public:
        /**
         * Constructor.
-        * @param msec  The time this event was generated.
-        * @param type  The type of key event.
-        * @param key   The key code of the key.
+        * \param msec  The time this event was generated.
+        * \param type  The type of key event.
+        * \param key   The key code of the key.
         */
        GHOST_EventKey(GHOST_TUns64 msec,
                       GHOST_TEventType type,
@@ -63,10 +63,10 @@ public:
        
        /**
         * Constructor.
-        * @param msec  The time this event was generated.
-        * @param type  The type of key event.
-        * @param key   The key code of the key.
-        * @param ascii The ascii code for the key event.
+        * \param msec  The time this event was generated.
+        * \param type  The type of key event.
+        * \param key   The key code of the key.
+        * \param ascii The ascii code for the key event.
         */
        GHOST_EventKey(GHOST_TUns64 msec,
                       GHOST_TEventType type,
index 33e0afb..b8660b3 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 14, 2001
+ * \author     Maarten Gribnau
+ * \date       May 14, 2001
  */
 
 #include "GHOST_EventManager.h"
index eec0078..fea8214 100644 (file)
@@ -62,21 +62,21 @@ public:
 
        /**
         * Returns the number of events currently on the stack.
-        * @return The number of events on the stack.
+        * \return The number of events on the stack.
         */
        virtual GHOST_TUns32 getNumEvents();
 
        /**
         * Returns the number of events of a certain type currently on the stack.
-        * @param type The type of events to be counted.
-        * @return The number of events on the stack of this type.
+        * \param type The type of events to be counted.
+        * \return The number of events on the stack of this type.
         */
        virtual GHOST_TUns32 getNumEvents(GHOST_TEventType type);
 
        /**
         * Return the event at the top of the stack without removal.
         * Do not delete the event!
-        * @return The event at the top of the stack.
+        * \return The event at the top of the stack.
         */
        virtual GHOST_IEvent *peekEvent();
 
@@ -84,47 +84,47 @@ public:
         * Pushes an event on the stack.
         * To dispatch it, call dispatchEvent() or dispatchEvents().
         * Do not delete the event!
-        * @param event The event to push on the stack.
+        * \param event The event to push on the stack.
         */
        virtual GHOST_TSuccess pushEvent(GHOST_IEvent *event);
 
        /**
         * Dispatches the given event directly, bypassing the event stack.
-        * @return Indication as to whether any of the consumers handled the event.
+        * \return Indication as to whether any of the consumers handled the event.
         */
        virtual bool dispatchEvent(GHOST_IEvent *event);
 
        /**
         * Dispatches the event at the back of the stack.
         * The event will be removed from the stack.
-        * @return Indication as to whether any of the consumers handled the event.
+        * \return Indication as to whether any of the consumers handled the event.
         */
        virtual bool dispatchEvent();
 
        /**
         * Dispatches all the events on the stack.
         * The event stack will be empty afterwards.
-        * @return Indication as to whether any of the consumers handled the events.
+        * \return Indication as to whether any of the consumers handled the events.
         */
        virtual bool dispatchEvents();
 
        /**
         * Adds a consumer to the list of event consumers.
-        * @param consumer The consumer added to the list.
-        * @return Indication as to whether addition has succeeded.
+        * \param consumer The consumer added to the list.
+        * \return Indication as to whether addition has succeeded.
         */
        virtual GHOST_TSuccess addConsumer(GHOST_IEventConsumer *consumer);
 
        /**
         * Removes a consumer from the list of event consumers.
-        * @param consumer The consumer removed from the list.
-        * @return Indication as to whether removal has succeeded.
+        * \param consumer The consumer removed from the list.
+        * \return Indication as to whether removal has succeeded.
         */
        virtual GHOST_TSuccess removeConsumer(GHOST_IEventConsumer *consumer);
 
        /**
         * Removes all events for a window from the stack.
-        * @param       window  The window to remove events for.
+        * \param       window  The window to remove events for.
         */
        virtual void
        removeWindowEvents(
@@ -135,8 +135,8 @@ public:
         * Removes all events of a certain type from the stack.
         * The window parameter is optional. If non-null, the routine will remove
         * events only associated with that window.
-        * @param       type    The type of events to be removed.
-        * @param       window  The window to remove the events for.
+        * \param       type    The type of events to be removed.
+        * \param       window  The window to remove the events for.
         */
        virtual void
        removeTypeEvents(
@@ -148,7 +148,7 @@ protected:
        /**
         * Returns the event at the top of the stack and removes it.
         * Delete the event after use!
-        * @return The event at the top of the stack.
+        * \return The event at the top of the stack.
         */
        virtual GHOST_IEvent *popEvent();
 
index f5fe303..280d420 100644 (file)
@@ -46,16 +46,16 @@ class GHOST_EventPrinter : public GHOST_IEventConsumer
 public:
        /**
         * Prints all the events received to std out.
-        * @param event The event that can be handled or not.
-        * @return Indication as to whether the event was handled.
+        * \param event The event that can be handled or not.
+        * \return Indication as to whether the event was handled.
         */
        virtual bool processEvent(GHOST_IEvent *event);
 
 protected:
        /**
         * Converts GHOST key code to a readable string.
-        * @param key The GHOST key code to convert.
-        * @param str The GHOST key code converted to a readable string.
+        * \param key The GHOST key code to convert.
+        * \param str The GHOST key code converted to a readable string.
         */
        void getKeyString(GHOST_TKey key, char str[32]) const;
 };
index 8611944..391af0f 100644 (file)
 
 /**
  * Generic class for events with string data
- * @author     Damien Plisson
- * @date       Feb 1, 2010
+ * \author     Damien Plisson
+ * \date       Feb 1, 2010
  */
 class GHOST_EventString : public GHOST_Event
 {
 public:
        /**
         * Constructor.
-        * @param msec  The time this event was generated.
-        * @param type  The type of this event.
-        * @param window The generating window (or NULL if system event).
-        * @param data_ptr Pointer to the (unformatted) data associated with the event
+        * \param msec  The time this event was generated.
+        * \param type  The type of this event.
+        * \param window The generating window (or NULL if system event).
+        * \param data_ptr Pointer to the (unformatted) data associated with the event
         */
        GHOST_EventString(GHOST_TUns64 msec, GHOST_TEventType type, GHOST_IWindow *window, GHOST_TEventDataPtr data_ptr)
                : GHOST_Event(msec, type, window)
index ab576fb..dc8b164 100644 (file)
@@ -44,11 +44,11 @@ class GHOST_EventTrackpad : public GHOST_Event
 public:
        /**
         * Constructor.
-        * @param msec          The time this event was generated.
-        * @param type          The type of this event.
-        * @param subtype       The subtype of the event.
-        * @param x                     The x-delta of the pan event.
-        * @param y                     The y-delta of the pan event.
+        * \param msec          The time this event was generated.
+        * \param type          The type of this event.
+        * \param subtype       The subtype of the event.
+        * \param x                     The x-delta of the pan event.
+        * \param y                     The y-delta of the pan event.
         */
        GHOST_EventTrackpad(GHOST_TUns64 msec,
                            GHOST_IWindow *window,
index 7d6137a..216f13f 100644 (file)
  * Mouse wheel event.
  * The displacement of the mouse wheel is counted in ticks.
  * A positive value means the wheel is turned away from the user.
- * @author     Maarten Gribnau
- * @date       May 11, 2001
+ * \author     Maarten Gribnau
+ * \date       May 11, 2001
  */
 class GHOST_EventWheel : public GHOST_Event
 {
 public:
        /**
         * Constructor.
-        * @param msec          The time this event was generated.
-        * @param type          The type of this event.
-        * @param z                     The displacement of the mouse wheel.
+        * \param msec          The time this event was generated.
+        * \param type          The type of this event.
+        * \param z                     The displacement of the mouse wheel.
         */
        GHOST_EventWheel(GHOST_TUns64 msec, GHOST_IWindow *window, GHOST_TInt32 z)
                : GHOST_Event(msec, GHOST_kEventWheel, window)
index fe1132e..f6973ca 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 7, 2001
+ * \author     Maarten Gribnau
+ * \date       May 7, 2001
  */
 
 #include "GHOST_ISystem.h"
index f84c507..ae9a8e4 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 7, 2001
+ * \author     Maarten Gribnau
+ * \date       May 7, 2001
  */
 
 #include "GHOST_ISystemPaths.h"
index ffc7a09..d25d0be 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 31, 2001
+ * \author     Maarten Gribnau
+ * \date       May 31, 2001
  */
 
 #include "GHOST_ModifierKeys.h"
index 064af8d..8189006 100644 (file)
@@ -38,8 +38,8 @@
 /**
  * Stores the state of modifier keys.
  * Discriminates between left and right modifier keys.
- * @author     Maarten Gribnau
- * @date       May 17, 2001
+ * \author     Maarten Gribnau
+ * \date       May 17, 2001
  */
 struct GHOST_ModifierKeys {
        /**
@@ -51,23 +51,23 @@ struct GHOST_ModifierKeys {
 
        /**
         * Returns the modifier key's key code from a modifier key mask.
-        * @param mask The mask of the modifier key.
-        * @return The modifier key's key code.
+        * \param mask The mask of the modifier key.
+        * \return The modifier key's key code.
         */
        static GHOST_TKey getModifierKeyCode(GHOST_TModifierKeyMask mask);
 
 
        /**
         * Returns the state of a single modifier key.
-        * @param mask. Key state to return.
-        * @return The state of the key (pressed == true).
+        * \param mask. Key state to return.
+        * \return The state of the key (pressed == true).
         */
        virtual bool get(GHOST_TModifierKeyMask mask) const;
 
        /**
         * Updates the state of a single modifier key.
-        * @param mask. Key state to update.
-        * @param down. The new state of the key.
+        * \param mask. Key state to update.
+        * \param down. The new state of the key.
         */
        virtual void set(GHOST_TModifierKeyMask mask, bool down);
 
@@ -78,8 +78,8 @@ struct GHOST_ModifierKeys {
 
        /**
         * Determines whether to modifier key states are equal.
-        * @param keys. The modifier key state to compare to.
-        * @return Indication of equality.
+        * \param keys. The modifier key state to compare to.
+        * \return Indication of equality.
         */
        virtual bool equals(const GHOST_ModifierKeys& keys) const;
 
index de475c7..070bf91 100644 (file)
@@ -55,9 +55,9 @@ class GHOST_NDOFManager;
  * interface.
  * GHOST_System is an abstract class because not all methods of GHOST_ISystem
  * are implemented.
- * @see GHOST_ISystem.
- * @author     Maarten Gribnau
- * @date       May 7, 2001
+ * \see GHOST_ISystem.
+ * \author     Maarten Gribnau
+ * \date       May 7, 2001
  */
 class GHOST_System : public GHOST_ISystem
 {
@@ -83,7 +83,7 @@ public:
         * Returns the system time.
         * Returns the number of milliseconds since the start of the system process.
         * Based on ANSI clock() routine.
-        * @return The number of milliseconds.
+        * \return The number of milliseconds.
         */
        virtual GHOST_TUns64 getMilliSeconds() const;
 
@@ -91,11 +91,11 @@ public:
         * Installs a timer.
         * Note that, on most operating systems, messages need to be processed in order 
         * for the timer callbacks to be invoked.
-        * @param delay         The time to wait for the first call to the timerProc (in milliseconds)
-        * @param interval      The interval between calls to the timerProc
-        * @param timerProc     The callback invoked when the interval expires,
-        * @param userData      Placeholder for user data.
-        * @return A timer task (0 if timer task installation failed).
+        * \param delay         The time to wait for the first call to the timerProc (in milliseconds)
+        * \param interval      The interval between calls to the timerProc
+        * \param timerProc     The callback invoked when the interval expires,
+        * \param userData      Placeholder for user data.
+        * \return A timer task (0 if timer task installation failed).
         */
        virtual GHOST_ITimerTask *installTimer(GHOST_TUns64 delay,
                                               GHOST_TUns64 interval,
@@ -104,8 +104,8 @@ public:
 
        /**
         * Removes a timer.
-        * @param timerTask Timer task to be removed.
-        * @return Indication of success.
+        * \param timerTask Timer task to be removed.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess removeTimer(GHOST_ITimerTask *timerTask);
 
@@ -123,47 +123,47 @@ public:
 
        /**
         * Dispose a window.
-        * @param       window Pointer to the window to be disposed.
-        * @return      Indication of success.
+        * \param       window Pointer to the window to be disposed.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess disposeWindow(GHOST_IWindow *window);
 
        /**
         * Returns whether a window is valid.
-        * @param       window Pointer to the window to be checked.
-        * @return      Indication of validity.
+        * \param       window Pointer to the window to be checked.
+        * \return      Indication of validity.
         */
        virtual bool validWindow(GHOST_IWindow *window);
 
        /**
         * Begins full screen mode.
-        * @param setting       The new setting of the display.
-        * @param window        Window displayed in full screen.
-        * @param stereoVisual  Stereo visual for quad buffered stereo.
+        * \param setting       The new setting of the display.
+        * \param window        Window displayed in full screen.
+        * \param stereoVisual  Stereo visual for quad buffered stereo.
         * This window is invalid after full screen has been ended.
-        * @return      Indication of success.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess beginFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow **window,
                                               const bool stereoVisual, const GHOST_TUns16 numOfAASamples = 0);
                
        /**
         * Updates the resolution while in fullscreen mode.
-        * @param setting       The new setting of the display.
-        * @param window        Window displayed in full screen.
+        * \param setting       The new setting of the display.
+        * \param window        Window displayed in full screen.
         *
-        * @return      Indication of success.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess updateFullScreen(const GHOST_DisplaySetting& setting, GHOST_IWindow **window);
 
        /**
         * Ends full screen mode.
-        * @return      Indication of success.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess endFullScreen(void);
 
        /**
         * Returns current full screen mode status.
-        * @return The current status.
+        * \return The current status.
         */
        virtual bool getFullScreen(void);
 
@@ -183,21 +183,21 @@ public:
        /**
         * Dispatches all the events on the stack.
         * The event stack will be empty afterwards.
-        * @return Indication as to whether any of the consumers handled the events.
+        * \return Indication as to whether any of the consumers handled the events.
         */
        virtual bool dispatchEvents();
 
        /**
         * Adds the given event consumer to our list.
-        * @param consumer The event consumer to add.
-        * @return Indication of success.
+        * \param consumer The event consumer to add.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess addEventConsumer(GHOST_IEventConsumer *consumer);
 
        /**
         * Remove the given event consumer to our list.
-        * @param consumer The event consumer to remove.
-        * @return Indication of success.
+        * \param consumer The event consumer to remove.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess removeEventConsumer(GHOST_IEventConsumer *consumer);
 
@@ -216,17 +216,17 @@ public:
 
        /**
         * Returns the state of a modifier key (ouside the message queue).
-        * @param mask          The modifier key state to retrieve.
-        * @param isDown        The state of a modifier key (true == pressed).
-        * @return                      Indication of success.
+        * \param mask          The modifier key state to retrieve.
+        * \param isDown        The state of a modifier key (true == pressed).
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getModifierKeyState(GHOST_TModifierKeyMask mask, bool& isDown) const;
 
        /**
         * Returns the state of a mouse button (ouside the message queue).
-        * @param mask          The button state to retrieve.
-        * @param isDown        Button state.
-        * @return                      Indication of success.
+        * \param mask          The button state to retrieve.
+        * \param isDown        Button state.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getButtonState(GHOST_TButtonMask mask, bool& isDown) const;
        
@@ -238,62 +238,62 @@ public:
         * Pushes an event on the stack.
         * To dispatch it, call dispatchEvent() or dispatchEvents().
         * Do not delete the event!
-        * @param event The event to push on the stack.
+        * \param event The event to push on the stack.
         */
        virtual GHOST_TSuccess pushEvent(GHOST_IEvent *event);
 
        /**
         * Returns the timer manager.
-        * @return The timer manager.
+        * \return The timer manager.
         */
        inline virtual GHOST_TimerManager *getTimerManager() const;
 
        /**
         * Returns a pointer to our event manager.
-        * @return A pointer to our event manager.
+        * \return A pointer to our event manager.
         */
        virtual inline GHOST_EventManager *getEventManager() const;
 
        /**
         * Returns a pointer to our window manager.
-        * @return A pointer to our window manager.
+        * \return A pointer to our window manager.
         */
        virtual inline GHOST_WindowManager *getWindowManager() const;
 
 #ifdef WITH_INPUT_NDOF
        /**
         * Returns a pointer to our n-degree of freedeom manager.
-        * @return A pointer to our n-degree of freedeom manager.
+        * \return A pointer to our n-degree of freedeom manager.
         */
        virtual inline GHOST_NDOFManager *getNDOFManager() const;
 #endif
 
        /**
         * Returns the state of all modifier keys.
-        * @param keys  The state of all modifier keys (true == pressed).
-        * @return              Indication of success.
+        * \param keys  The state of all modifier keys (true == pressed).
+        * \return              Indication of success.
         */
        virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const = 0;
 
        /**
         * Returns the state of the mouse buttons (ouside the message queue).
-        * @param buttons       The state of the buttons.
-        * @return                      Indication of success.
+        * \param buttons       The state of the buttons.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const = 0;
 
        /**
         * Returns the selection buffer
-        * @param selection             Only used on X11
-        * @return              Returns the clipboard data
+        * \param selection             Only used on X11
+        * \return              Returns the clipboard data
         *
         */
        virtual GHOST_TUns8 *getClipboard(bool selection) const = 0;
          
        /**
         * Put data to the Clipboard
-        * @param buffer                The buffer to copy to the clipboard
-        * @param selection     The clipboard to copy too only used on X11
+        * \param buffer                The buffer to copy to the clipboard
+        * \param selection     The clipboard to copy too only used on X11
         */
        virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const = 0;
 
@@ -308,20 +308,20 @@ public:
 protected:
        /**
         * Initialize the system.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess init();
 
        /**
         * Shut the system down.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess exit();
 
        /**
         * Creates a fullscreen window.
-        * @param window The window created.
-        * @return Indication of success.
+        * \param window The window created.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess createFullScreenWindow(GHOST_Window **window,
                                                      const bool stereoVisual, const GHOST_TUns16 numOfAASamples = 0);
index ffb8388..bb68ce8 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 7, 2001
+ * \author     Maarten Gribnau
+ * \date       May 7, 2001
  */
 
 #include <Carbon/Carbon.h>
@@ -990,7 +990,7 @@ bool GHOST_SystemCarbon::handleMouseDown(EventRef event)
                        /*
                         * The DragWindow() routine creates a lot of kEventWindowBoundsChanged
                         * events. By setting m_ignoreWindowSizedMessages these are suppressed.
-                        * @see GHOST_SystemCarbon::handleWindowEvent(EventRef event)
+                        * \see GHOST_SystemCarbon::handleWindowEvent(EventRef event)
                         */
                        /* even worse: scale window also generates a load of events, and nothing 
                         * is handled (read: client's event proc called) until you release mouse (ton) */
index 2415c57..61e5a08 100644 (file)
@@ -48,9 +48,9 @@ class GHOST_EventWindow;
 
 /**
  * OSX/Carbon Implementation of GHOST_System class.
- * @see GHOST_System.
- * @author     Maarten Gribnau
- * @date       May 21, 2001
+ * \see GHOST_System.
+ * \author     Maarten Gribnau
+ * \date       May 21, 2001
  */
 class GHOST_SystemCarbon : public GHOST_System {
 public:
@@ -72,7 +72,7 @@ public:
         * Returns the system time.
         * Returns the number of milliseconds since the start of the system process.
         * Based on ANSI clock() routine.
-        * @return The number of milliseconds.
+        * \return The number of milliseconds.
         */
        virtual GHOST_TUns64 getMilliSeconds() const;
 
@@ -82,13 +82,13 @@ public:
 
        /**
         * Returns the number of displays on this system.
-        * @return The number of displays.
+        * \return The number of displays.
         */
        virtual GHOST_TUns8 getNumDisplays() const;
 
        /**
         * Returns the dimensions of the main display on this system.
-        * @return The dimension of the main display.
+        * \return The dimension of the main display.
         */
        virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
        
@@ -96,15 +96,15 @@ public:
         * Create a new window.
         * The new window is added to the list of windows managed. 
         * Never explicitly delete the window, use disposeWindow() instead.
-        * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
-        * @param       left    The coordinate of the left edge of the window.
-        * @param       top             The coordinate of the top edge of the window.
-        * @param       width   The width the window.
-        * @param       height  The height the window.
-        * @param       state   The state of the window when opened.
-        * @param       type    The type of drawing context installed in this window.
-        * @param       parentWindow Parent (embedder) window
-        * @return      The new window (or 0 if creation failed).
+        * \param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
+        * \param       left    The coordinate of the left edge of the window.
+        * \param       top             The coordinate of the top edge of the window.
+        * \param       width   The width the window.
+        * \param       height  The height the window.
+        * \param       state   The state of the window when opened.
+        * \param       type    The type of drawing context installed in this window.
+        * \param       parentWindow Parent (embedder) window
+        * \return      The new window (or 0 if creation failed).
         */
        virtual GHOST_IWindow *createWindow(
            const STR_String& title,
@@ -133,8 +133,8 @@ public:
 
        /**
         * Gets events from the system and stores them in the queue.
-        * @param waitForEvent Flag to wait for an event (or return immediately).
-        * @return Indication of the presence of events.
+        * \param waitForEvent Flag to wait for an event (or return immediately).
+        * \return Indication of the presence of events.
         */
        virtual bool processEvents(bool waitForEvent);
        
@@ -144,17 +144,17 @@ public:
 
        /**
         * Returns the current location of the cursor (location in screen coordinates)
-        * @param x                     The x-coordinate of the cursor.
-        * @param y                     The y-coordinate of the cursor.
-        * @return                      Indication of success.
+        * \param x                     The x-coordinate of the cursor.
+        * \param y                     The y-coordinate of the cursor.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
 
        /**
         * Updates the location of the cursor (location in screen coordinates).
-        * @param x                     The x-coordinate of the cursor.
-        * @param y                     The y-coordinate of the cursor.
-        * @return                      Indication of success.
+        * \param x                     The x-coordinate of the cursor.
+        * \param y                     The y-coordinate of the cursor.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
 
@@ -164,34 +164,34 @@ public:
 
        /**
         * Returns the state of all modifier keys.
-        * @param keys  The state of all modifier keys (true == pressed).
-        * @return              Indication of success.
+        * \param keys  The state of all modifier keys (true == pressed).
+        * \return              Indication of success.
         */
        virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
 
        /**
         * Returns the state of the mouse buttons (ouside the message queue).
-        * @param buttons       The state of the buttons.
-        * @return                      Indication of success.
+        * \param buttons       The state of the buttons.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
 
        /**
         * Returns Clipboard data
-        * @param selection             Indicate which buffer to return
-        * @return                              Returns the selected buffer
+        * \param selection             Indicate which buffer to return
+        * \return                              Returns the selected buffer
         */
        virtual GHOST_TUns8 *getClipboard(bool selection) const;
        
        /**
         * Puts buffer to system clipboard
-        * @param buffer        The buffer to be copied
-        * @param selection     Indicates which buffer to copy too, only used on X11
+        * \param buffer        The buffer to be copied
+        * \param selection     Indicates which buffer to copy too, only used on X11
         */
        virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
 
        /**
-        * @see GHOST_ISystem
+        * \see GHOST_ISystem
         */
        int toggleConsole(int action) {
                return 0;
@@ -201,55 +201,55 @@ protected:
        /**
         * Initializes the system.
         * For now, it justs registers the window class (WNDCLASS).
-        * @return A success value.
+        * \return A success value.
         */
        virtual GHOST_TSuccess init();
 
        /**
         * Closes the system down.
-        * @return A success value.
+        * \return A success value.
         */
        virtual GHOST_TSuccess exit();
 
        
        /**
         * Handles a tablet event.
-        * @param event A Mac event.
-        * @return Indication whether the event was handled.
+        * \param event A Mac event.
+        * \return Indication whether the event was handled.
         */
        OSStatus handleTabletEvent(EventRef event);
        /**
         * Handles a mouse event.
-        * @param event A Mac event.
-        * @return Indication whether the event was handled.
+        * \param event A Mac event.
+        * \return Indication whether the event was handled.
         */
        OSStatus handleMouseEvent(EventRef event);
 
        /**
         * Handles a key event.
-        * @param event A Mac event.
-        * @return Indication whether the event was handled.
+        * \param event A Mac event.
+        * \return Indication whether the event was handled.
         */
        OSStatus handleKeyEvent(EventRef event);
 
        /**
         * Handles a window event.
-        * @param event A Mac event.
-        * @return Indication whether the event was handled.
+        * \param event A Mac event.
+        * \return Indication whether the event was handled.
         */
        OSStatus handleWindowEvent(EventRef event);
 
        /**
         * Handles all basic Mac application stuff for a mouse down event.
-        * @param event A Mac event.
-        * @return Indication whether the event was handled.
+        * \param event A Mac event.
+        * \return Indication whether the event was handled.
         */
        bool handleMouseDown(EventRef event);
 
        /**
         * Handles a Mac menu command.
-        * @param menuResult A Mac menu/item identifier.
-        * @return Indication whether the event was handled.
+        * \param menuResult A Mac menu/item identifier.
+        * \return Indication whether the event was handled.
         */
        bool handleMenuCommand(GHOST_TInt32 menuResult);
 
@@ -270,7 +270,7 @@ protected:
 
        /**
         * Callback for Mac Timer tasks that expire.
-        * @param tmTask Pointer to the timer task that expired.
+        * \param tmTask Pointer to the timer task that expired.
         */
        //static void s_timerCallback(TMTaskPtr tmTask);
 
index cb4e9fe..08f982f 100644 (file)
@@ -69,7 +69,7 @@ public:
         * Returns the system time.
         * Returns the number of milliseconds since the start of the system process.
         * Based on ANSI clock() routine.
-        * @return The number of milliseconds.
+        * \return The number of milliseconds.
         */
        virtual GHOST_TUns64 getMilliSeconds() const;
 
@@ -79,13 +79,13 @@ public:
 
        /**
         * Returns the number of displays on this system.
-        * @return The number of displays.
+        * \return The number of displays.
         */
        virtual GHOST_TUns8 getNumDisplays() const;
 
        /**
         * Returns the dimensions of the main display on this system.
-        * @return The dimension of the main display.
+        * \return The dimension of the main display.
         */
        virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
        
@@ -93,17 +93,17 @@ public:
         * Create a new window.
         * The new window is added to the list of windows managed.
         * Never explicitly delete the window, use disposeWindow() instead.
-        * @param       title                   The name of the window (displayed in the title bar of the window if the OS supports it).
-        * @param       left                    The coordinate of the left edge of the window.
-        * @param       top                             The coordinate of the top edge of the window.
-        * @param       width                   The width the window.
-        * @param       height                  The height the window.
-        * @param       state                   The state of the window when opened.
-        * @param       type                    The type of drawing context installed in this window.
-        * @param       stereoVisual    Stereo visual for quad buffered stereo.
-        * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
-        * @param       parentWindow    Parent (embedder) window
-        * @return      The new window (or 0 if creation failed).
+        * \param       title                   The name of the window (displayed in the title bar of the window if the OS supports it).
+        * \param       left                    The coordinate of the left edge of the window.
+        * \param       top                             The coordinate of the top edge of the window.
+        * \param       width                   The width the window.
+        * \param       height                  The height the window.
+        * \param       state                   The state of the window when opened.
+        * \param       type                    The type of drawing context installed in this window.
+        * \param       stereoVisual    Stereo visual for quad buffered stereo.
+        * \param       numOfAASamples  Number of samples used for AA (zero if no AA)
+        * \param       parentWindow    Parent (embedder) window
+        * \return      The new window (or 0 if creation failed).
         */
        virtual GHOST_IWindow *createWindow(
            const STR_String& title,
@@ -124,8 +124,8 @@ public:
 
        /**
         * Gets events from the system and stores them in the queue.
-        * @param waitForEvent Flag to wait for an event (or return immediately).
-        * @return Indication of the presence of events.
+        * \param waitForEvent Flag to wait for an event (or return immediately).
+        * \return Indication of the presence of events.
         */
        virtual bool processEvents(bool waitForEvent);
        
@@ -143,12 +143,12 @@ public:
        
        /**
         * Handles a drag'n'drop destination event. Called by GHOST_WindowCocoa window subclass
-        * @param eventType The type of drag'n'drop event
-        * @param draggedObjectType The type object concerned (currently array of file names, string, TIFF image)
-        * @param mouseX x mouse coordinate (in cocoa base window coordinates)
-        * @param mouseY y mouse coordinate
-        * @param window The window on which the event occurred
-        * @return Indication whether the event was handled.
+        * \param eventType The type of drag'n'drop event
+        * \param draggedObjectType The type object concerned (currently array of file names, string, TIFF image)
+        * \param mouseX x mouse coordinate (in cocoa base window coordinates)
+        * \param mouseY y mouse coordinate
+        * \param window The window on which the event occurred
+        * \return Indication whether the event was handled.
         */
        GHOST_TSuccess handleDraggingEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,
                                           GHOST_WindowCocoa *window, int mouseX, int mouseY, void *data);
@@ -159,17 +159,17 @@ public:
 
        /**
         * Returns the current location of the cursor (location in screen coordinates)
-        * @param x                     The x-coordinate of the cursor.
-        * @param y                     The y-coordinate of the cursor.
-        * @return                      Indication of success.
+        * \param x                     The x-coordinate of the cursor.
+        * \param y                     The y-coordinate of the cursor.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
 
        /**
         * Updates the location of the cursor (location in screen coordinates).
-        * @param x                     The x-coordinate of the cursor.
-        * @param y                     The y-coordinate of the cursor.
-        * @return                      Indication of success.
+        * \param x                     The x-coordinate of the cursor.
+        * \param y                     The y-coordinate of the cursor.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
        
@@ -179,43 +179,43 @@ public:
 
        /**
         * Returns the state of all modifier keys.
-        * @param keys  The state of all modifier keys (true == pressed).
-        * @return              Indication of success.
+        * \param keys  The state of all modifier keys (true == pressed).
+        * \return              Indication of success.
         */
        virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
 
        /**
         * Returns the state of the mouse buttons (ouside the message queue).
-        * @param buttons       The state of the buttons.
-        * @return                      Indication of success.
+        * \param buttons       The state of the buttons.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
 
        /**
         * Returns Clipboard data
-        * @param selection             Indicate which buffer to return
-        * @return                              Returns the selected buffer
+        * \param selection             Indicate which buffer to return
+        * \return                              Returns the selected buffer
         */
        virtual GHOST_TUns8 *getClipboard(bool selection) const;
        
        /**
         * Puts buffer to system clipboard
-        * @param buffer        The buffer to be copied
-        * @param selection     Indicates which buffer to copy too, only used on X11
+        * \param buffer        The buffer to be copied
+        * \param selection     Indicates which buffer to copy too, only used on X11
         */
        virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
 
        /**
         * Handles a window event. Called by GHOST_WindowCocoa window delegate
-        * @param eventType The type of window event
-        * @param window The window on which the event occurred
-        * @return Indication whether the event was handled.
+        * \param eventType The type of window event
+        * \param window The window on which the event occurred
+        * \return Indication whether the event was handled.
         */
        GHOST_TSuccess handleWindowEvent(GHOST_TEventType eventType, GHOST_WindowCocoa *window);
        
        /**
         * Handles the Cocoa event telling the application has become active (again)
-        * @return Indication whether the event was handled.
+        * \return Indication whether the event was handled.
         */
        GHOST_TSuccess handleApplicationBecomeActiveEvent();
 
@@ -225,7 +225,7 @@ public:
        void notifyExternalEventProcessed();
 
        /**
-        * @see GHOST_ISystem
+        * \see GHOST_ISystem
         */
        int toggleConsole(int action) {
                return 0;
@@ -236,40 +236,40 @@ protected:
        /**
         * Initializes the system.
         * For now, it justs registers the window class (WNDCLASS).
-        * @return A success value.
+        * \return A success value.
         */
        virtual GHOST_TSuccess init();
 
        /**
         * Handles a tablet event.
-        * @param eventPtr      An NSEvent pointer (casted to void* to enable compilation in standard C++)
-        * @param eventType The type of the event.
+        * \param eventPtr      An NSEvent pointer (casted to void* to enable compilation in standard C++)
+        * \param eventType The type of the event.
         * It needs to be passed separately as it can be either directly in the event type,
         * or as a subtype if combined with a mouse button event.
-        * @return Indication whether the event was handled.
+        * \return Indication whether the event was handled.
         */
        GHOST_TSuccess handleTabletEvent(void *eventPtr, short eventType);
        bool handleTabletEvent(void *eventPtr);
 
        /**
         * Handles a mouse event.
-        * @param eventPtr      An NSEvent pointer (casted to void* to enable compilation in standard C++)
-        * @return Indication whether the event was handled.
+        * \param eventPtr      An NSEvent pointer (casted to void* to enable compilation in standard C++)
+        * \return Indication whether the event was handled.
         */
        GHOST_TSuccess handleMouseEvent(void *eventPtr);
 
        /**
         * Handles a key event.
-        * @param eventPtr      An NSEvent pointer (casted to void* to enable compilation in standard C++)
-        * @return Indication whether the event was handled.
+        * \param eventPtr      An NSEvent pointer (casted to void* to enable compilation in standard C++)
+        * \return Indication whether the event was handled.
         */
        GHOST_TSuccess handleKeyEvent(void *eventPtr);
 
        /**
         * Performs the actual cursor position update (location in screen coordinates).
-        * @param x                     The x-coordinate of the cursor.
-        * @param y                     The y-coordinate of the cursor.
-        * @return                      Indication of success.
+        * \param x                     The x-coordinate of the cursor.
+        * \param y                     The y-coordinate of the cursor.
+        * \return                      Indication of success.
         */
        GHOST_TSuccess setMouseCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
 
index 1bffbc8..7bc4028 100644 (file)
@@ -228,9 +228,9 @@ static GHOST_TButtonMask convertButton(int button)
 /**
  * Converts Mac rawkey codes (same for Cocoa & Carbon)
  * into GHOST key codes
- * @param rawCode The raw physical key code
- * @param recvChar the character ignoring modifiers (except for shift)
- * @return Ghost key code
+ * \param rawCode The raw physical key code
+ * \param recvChar the character ignoring modifiers (except for shift)
+ * \return Ghost key code
  */
 static GHOST_TKey convertKey(int rawCode, unichar recvChar, UInt16 keyAction) 
 {      
@@ -594,9 +594,8 @@ GHOST_SystemCocoa::~GHOST_SystemCocoa()
 
 GHOST_TSuccess GHOST_SystemCocoa::init()
 {
-       
-    GHOST_TSuccess success = GHOST_System::init();
-    if (success) {
+       GHOST_TSuccess success = GHOST_System::init();
+       if (success) {
 
 #ifdef WITH_INPUT_NDOF
                m_ndofManager = new GHOST_NDOFManagerCocoa(*this);
@@ -676,8 +675,8 @@ GHOST_TSuccess GHOST_SystemCocoa::init()
                [NSApp finishLaunching];
                
                [pool drain];
-    }
-    return success;
+       }
+       return success;
 }
 
 
@@ -739,7 +738,7 @@ GHOST_IWindow* GHOST_SystemCocoa::createWindow(
        const GHOST_TEmbedderWindowID parentWindow
 )
 {
-    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+       NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
        GHOST_IWindow* window = 0;
        
        //Get the available rect for including window contents
@@ -755,45 +754,44 @@ GHOST_IWindow* GHOST_SystemCocoa::createWindow(
 
        window = new GHOST_WindowCocoa (this, title, left, bottom, width, height, state, type, stereoVisual, numOfAASamples);
 
-    if (window) {
-        if (window->getValid()) {
-            // Store the pointer to the window 
-            GHOST_ASSERT(m_windowManager, "m_windowManager not initialized");
-            m_windowManager->addWindow(window);
-            m_windowManager->setActiveWindow(window);
+       if (window) {
+               if (window->getValid()) {
+                       // Store the pointer to the window
+                       GHOST_ASSERT(m_windowManager, "m_windowManager not initialized");
+                       m_windowManager->addWindow(window);
+                       m_windowManager->setActiveWindow(window);
                        //Need to tell window manager the new window is the active one (Cocoa does not send the event activate upon window creation)
-            pushEvent(new GHOST_Event(getMilliSeconds(), GHOST_kEventWindowActivate, window));
+                       pushEvent(new GHOST_Event(getMilliSeconds(), GHOST_kEventWindowActivate, window));
                        pushEvent(new GHOST_Event(getMilliSeconds(), GHOST_kEventWindowSize, window));
-
-        }
-        else {
+               }
+               else {
                        GHOST_PRINT("GHOST_SystemCocoa::createWindow(): window invalid\n");
-            delete window;
-            window = 0;
-        }
-    }
+                       delete window;
+                       window = 0;
+               }
+       }
        else {
                GHOST_PRINT("GHOST_SystemCocoa::createWindow(): could not create window\n");
        }
        [pool drain];
-    return window;
+       return window;
 }
 
 /**
- * @note : returns coordinates in Cocoa screen coordinates
+ * \note : returns coordinates in Cocoa screen coordinates
  */
 GHOST_TSuccess GHOST_SystemCocoa::getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const
 {
-    NSPoint mouseLoc = [NSEvent mouseLocation];
+       NSPoint mouseLoc = [NSEvent mouseLocation];
        
-    // Returns the mouse location in screen coordinates
-    x = (GHOST_TInt32)mouseLoc.x;
-    y = (GHOST_TInt32)mouseLoc.y;
-    return GHOST_kSuccess;
+       // Returns the mouse location in screen coordinates
+       x = (GHOST_TInt32)mouseLoc.x;
+       y = (GHOST_TInt32)mouseLoc.y;
+       return GHOST_kSuccess;
 }
 
 /**
- * @note : expect Cocoa screen coordinates
+ * \note : expect Cocoa screen coordinates
  */
 GHOST_TSuccess GHOST_SystemCocoa::setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y)
 {
@@ -833,7 +831,7 @@ GHOST_TSuccess GHOST_SystemCocoa::setMouseCursorPosition(GHOST_TInt32 x, GHOST_T
        CGDisplayMoveCursorToPoint((CGDirectDisplayID)[[[windowScreen deviceDescription] objectForKey:@"NSScreenNumber"] unsignedIntValue], CGPointMake(xf, yf));
 
        [pool drain];
-    return GHOST_kSuccess;
+       return GHOST_kSuccess;
 }
 
 
@@ -844,18 +842,18 @@ GHOST_TSuccess GHOST_SystemCocoa::getModifierKeys(GHOST_ModifierKeys& keys) cons
        keys.set(GHOST_kModifierKeyLeftShift, (m_modifierMask & NSShiftKeyMask) ? true : false);
        keys.set(GHOST_kModifierKeyLeftControl, (m_modifierMask & NSControlKeyMask) ? true : false);
        
-    return GHOST_kSuccess;
+       return GHOST_kSuccess;
 }
 
 GHOST_TSuccess GHOST_SystemCocoa::getButtons(GHOST_Buttons& buttons) const
 {
        buttons.clear();
-    buttons.set(GHOST_kButtonMaskLeft, m_pressedMouseButtons & GHOST_kButtonMaskLeft);
+       buttons.set(GHOST_kButtonMaskLeft, m_pressedMouseButtons & GHOST_kButtonMaskLeft);
        buttons.set(GHOST_kButtonMaskRight, m_pressedMouseButtons & GHOST_kButtonMaskRight);
        buttons.set(GHOST_kButtonMaskMiddle, m_pressedMouseButtons & GHOST_kButtonMaskMiddle);
        buttons.set(GHOST_kButtonMaskButton4, m_pressedMouseButtons & GHOST_kButtonMaskButton4);
        buttons.set(GHOST_kButtonMaskButton5, m_pressedMouseButtons & GHOST_kButtonMaskButton5);
-    return GHOST_kSuccess;
+       return GHOST_kSuccess;
 }
 
 
@@ -976,7 +974,7 @@ bool GHOST_SystemCocoa::processEvents(bool waitForEvent)
        
        m_ignoreWindowSizedMessages = false;
        
-    return anyProcessed;
+       return anyProcessed;
 }
 
 //Note: called from NSApplication delegate
@@ -1442,7 +1440,7 @@ bool GHOST_SystemCocoa::handleTabletEvent(void *eventPtr)
 GHOST_TSuccess GHOST_SystemCocoa::handleMouseEvent(void *eventPtr)
 {
        NSEvent *event = (NSEvent *)eventPtr;
-    GHOST_WindowCocoa* window;
+       GHOST_WindowCocoa* window;
        
        window = (GHOST_WindowCocoa*)m_windowManager->getWindowAssociatedWithOSWindow((void*)[event window]);
        if (!window) {
@@ -1450,8 +1448,7 @@ GHOST_TSuccess GHOST_SystemCocoa::handleMouseEvent(void *eventPtr)
                return GHOST_kFailure;
        }
 
-       switch ([event type])
-    {
+       switch ([event type]) {
                case NSLeftMouseDown:
                case NSRightMouseDown:
                case NSOtherMouseDown:
@@ -1459,7 +1456,7 @@ GHOST_TSuccess GHOST_SystemCocoa::handleMouseEvent(void *eventPtr)
                        //Handle tablet events combined with mouse events
                        handleTabletEvent(event);
                        break;
-                                               
+
                case NSLeftMouseUp:
                case NSRightMouseUp:
                case NSOtherMouseUp:
index fe0fae7..53cad34 100644 (file)
@@ -53,20 +53,20 @@ public:
        /**
         * Determine the base dir in which shared resources are located. It will first try to use
         * "unpack and run" path, then look for properly installed path, including versioning.
-        * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
+        * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
         */
        virtual const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const = 0;
 
        /**
         * Determine the base dir in which user configuration is stored, including versioning.
         * If needed, it will create the base directory.
-        * @return Unsigned char string pointing to user dir (eg ~/.blender/).
+        * \return Unsigned char string pointing to user dir (eg ~/.blender/).
         */
        virtual const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const = 0;
 
        /**
         * Determine the directory of the current binary
-        * @return Unsigned char string pointing to the binary dir
+        * \return Unsigned char string pointing to the binary dir
         */
        virtual const GHOST_TUns8 *getBinaryDir() const = 0;
 
index 6a94c1d..9d9a3a2 100644 (file)
@@ -42,9 +42,9 @@
 
 /**
  * OSX/Carbon Implementation of GHOST_SystemPaths class.
- * @see GHOST_System.
- * @author     Andrea Weikert
- * @date       Aug 1, 2010
+ * \see GHOST_System.
+ * \author     Andrea Weikert
+ * \date       Aug 1, 2010
  */
 class GHOST_SystemPathsCarbon : public GHOST_SystemPaths {
 public:
@@ -61,20 +61,20 @@ public:
        /**
         * Determine the base dir in which shared resources are located. It will first try to use
         * "unpack and run" path, then look for properly installed path, including versioning.
-        * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
+        * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
         */
        virtual const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const;
 
        /**
         * Determine the base dir in which user configuration is stored, including versioning.
         * If needed, it will create the base directory.
-        * @return Unsigned char string pointing to user dir (eg ~/.blender/).
+        * \return Unsigned char string pointing to user dir (eg ~/.blender/).
         */
        virtual const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const;
 
        /**
         * Determine the directory of the current binary
-        * @return Unsigned char string pointing to the binary dir
+        * \return Unsigned char string pointing to the binary dir
         */
        virtual const GHOST_TUns8 *getBinaryDir() const;
 
index ad44396..cd8d161 100644 (file)
@@ -55,20 +55,20 @@ public:
        /**
         * Determine the base dir in which shared resources are located. It will first try to use
         * "unpack and run" path, then look for properly installed path, including versioning.
-        * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
+        * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
         */
        virtual const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const;
 
        /**
         * Determine the base dir in which user configuration is stored, including versioning.
         * If needed, it will create the base directory.
-        * @return Unsigned char string pointing to user dir (eg ~/.blender/).
+        * \return Unsigned char string pointing to user dir (eg ~/.blender/).
         */
        virtual const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const;
 
        /**
         * Determine the directory of the current binary
-        * @return Unsigned char string pointing to the binary dir
+        * \return Unsigned char string pointing to the binary dir
         */
        virtual const GHOST_TUns8 *getBinaryDir() const;
 
index 3a243f8..c074a79 100644 (file)
@@ -46,9 +46,9 @@
 
 /**
  * WIN32 Implementation of GHOST_SystemPaths class.
- * @see GHOST_SystemPaths.
- * @author     Andrea Weikert
- * @date       August 1, 2010
+ * \see GHOST_SystemPaths.
+ * \author     Andrea Weikert
+ * \date       August 1, 2010
  */
 class GHOST_SystemPathsWin32 : public GHOST_SystemPaths {
 public:
@@ -65,20 +65,20 @@ public:
        /**
         * Determine the base dir in which shared resources are located. It will first try to use
         * "unpack and run" path, then look for properly installed path, including versioning.
-        * @return Unsigned char string pointing to system dir (eg /usr/share/).
+        * \return Unsigned char string pointing to system dir (eg /usr/share/).
         */
        const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const;
 
        /**
         * Determine the base dir in which user configuration is stored, including versioning.
         * If needed, it will create the base directory.
-        * @return Unsigned char string pointing to user dir (eg ~/).
+        * \return Unsigned char string pointing to user dir (eg ~/).
         */
        const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const;
 
        /**
         * Determine the directory of the current binary
-        * @return Unsigned char string pointing to the binary dir
+        * \return Unsigned char string pointing to the binary dir
         */
        const GHOST_TUns8 *getBinaryDir() const;
 
index db6d5a6..1b5710e 100644 (file)
@@ -53,20 +53,20 @@ public:
        /**
         * Determine the base dir in which shared resources are located. It will first try to use
         * "unpack and run" path, then look for properly installed path, including versioning.
-        * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
+        * \return Unsigned char string pointing to system dir (eg /usr/share/blender/).
         */
        const GHOST_TUns8 *getSystemDir(int version, const char *versionstr) const;
 
        /**
         * Determine the base dir in which user configuration is stored, including versioning.
         * If needed, it will create the base directory.
-        * @return Unsigned char string pointing to user dir (eg ~/.blender/).
+        * \return Unsigned char string pointing to user dir (eg ~/.blender/).
         */
        const GHOST_TUns8 *getUserDir(int version, const char *versionstr) const;
 
        /**
         * Determine the directory of the current binary
-        * @return Unsigned char string pointing to the binary dir
+        * \return Unsigned char string pointing to the binary dir
         */
        const GHOST_TUns8 *getBinaryDir() const;
 
index f63ad38..6a756d3 100644 (file)
@@ -57,9 +57,9 @@ class GHOST_EventDragnDrop;
 
 /**
  * WIN32 Implementation of GHOST_System class.
- * @see GHOST_System.
- * @author     Maarten Gribnau
- * @date       May 10, 2001
+ * \see GHOST_System.
+ * \author     Maarten Gribnau
+ * \date       May 10, 2001
  */
 class GHOST_SystemWin32 : public GHOST_System {
 public:
@@ -81,7 +81,7 @@ public:
         * Returns the system time.
         * Returns the number of milliseconds since the start of the system process.
         * This overloaded method uses the high frequency timer if available.
-        * @return The number of milliseconds.
+        * \return The number of milliseconds.
         */
        virtual GHOST_TUns64 getMilliSeconds() const;
 
@@ -91,13 +91,13 @@ public:
 
        /**
         * Returns the number of displays on this system.
-        * @return The number of displays.
+        * \return The number of displays.
         */
        virtual GHOST_TUns8 getNumDisplays() const;
 
        /**
         * Returns the dimensions of the main display on this system.
-        * @return The dimension of the main display.
+        * \return The dimension of the main display.
         */
        virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
        
@@ -105,17 +105,17 @@ public:
         * Create a new window.
         * The new window is added to the list of windows managed. 
         * Never explicitly delete the window, use disposeWindow() instead.
-        * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
-        * @param       left    The coordinate of the left edge of the window.
-        * @param       top             The coordinate of the top edge of the window.
-        * @param       width   The width the window.
-        * @param       height  The height the window.
-        * @param       state   The state of the window when opened.
-        * @param       type    The type of drawing context installed in this window.
-        * @param       stereoVisual    Stereo visual for quad buffered stereo.
-        * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
-        * @param       parentWindow    Parent (embedder) window
-        * @return      The new window (or 0 if creation failed).
+        * \param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
+        * \param       left    The coordinate of the left edge of the window.
+        * \param       top             The coordinate of the top edge of the window.
+        * \param       width   The width the window.
+        * \param       height  The height the window.
+        * \param       state   The state of the window when opened.
+        * \param       type    The type of drawing context installed in this window.
+        * \param       stereoVisual    Stereo visual for quad buffered stereo.
+        * \param       numOfAASamples  Number of samples used for AA (zero if no AA)
+        * \param       parentWindow    Parent (embedder) window
+        * \return      The new window (or 0 if creation failed).
         */
        virtual GHOST_IWindow *createWindow(
            const STR_String& title,
@@ -131,8 +131,8 @@ public:
 
        /**
         * Gets events from the system and stores them in the queue.
-        * @param waitForEvent Flag to wait for an event (or return immediately).
-        * @return Indication of the presence of events.
+        * \param waitForEvent Flag to wait for an event (or return immediately).
+        * \return Indication of the presence of events.
         */
        virtual bool processEvents(bool waitForEvent);
        
@@ -143,17 +143,17 @@ public:
 
        /**
         * Returns the current location of the cursor (location in screen coordinates)
-        * @param x                     The x-coordinate of the cursor.
-        * @param y                     The y-coordinate of the cursor.
-        * @return                      Indication of success.
+        * \param x                     The x-coordinate of the cursor.
+        * \param y                     The y-coordinate of the cursor.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
 
        /**
         * Updates the location of the cursor (location in screen coordinates).
-        * @param x                     The x-coordinate of the cursor.
-        * @param y                     The y-coordinate of the cursor.
-        * @return                      Indication of success.
+        * \param x                     The x-coordinate of the cursor.
+        * \param y                     The y-coordinate of the cursor.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
 
@@ -163,41 +163,41 @@ public:
 
        /**
         * Returns the state of all modifier keys.
-        * @param keys  The state of all modifier keys (true == pressed).
-        * @return              Indication of success.
+        * \param keys  The state of all modifier keys (true == pressed).
+        * \return              Indication of success.
         */
        virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
 
        /**
         * Returns the state of the mouse buttons (ouside the message queue).
-        * @param buttons       The state of the buttons.
-        * @return                      Indication of success.
+        * \param buttons       The state of the buttons.
+        * \return                      Indication of success.
         */
        virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
 
        /**
         * Returns unsinged char from CUT_BUFFER0
-        * @param selection             Used by X11 only
-        * @return                              Returns the Clipboard
+        * \param selection             Used by X11 only
+        * \return                              Returns the Clipboard
         */
        virtual GHOST_TUns8 *getClipboard(bool selection) const;
        
        /**
         * Puts buffer to system clipboard
-        * @param selection             Used by X11 only
-        * @return                              No return
+        * \param selection             Used by X11 only
+        * \return                              No return
         */
        virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
 
        /**
         * Creates a drag'n'drop event and pushes it immediately onto the event queue. 
         * Called by GHOST_DropTargetWin32 class.
-        * @param eventType The type of drag'n'drop event
-        * @param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
-        * @param mouseX x mouse coordinate (in window coordinates)
-        * @param mouseY y mouse coordinate
-        * @param window The window on which the event occurred
-        * @return Indication whether the event was handled. 
+        * \param eventType The type of drag'n'drop event
+        * \param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
+        * \param mouseX x mouse coordinate (in window coordinates)
+        * \param mouseY y mouse coordinate
+        * \param window The window on which the event occurred
+        * \return Indication whether the event was handled.
         */
        static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType, GHOST_IWindow *window, int mouseX, int mouseY, void *data);
        
@@ -211,33 +211,33 @@ protected:
        /**
         * Initializes the system.
         * For now, it justs registers the window class (WNDCLASS).
-        * @return A success value.
+        * \return A success value.
         */
        virtual GHOST_TSuccess init();
 
        /**
         * Closes the system down.
-        * @return A success value.
+        * \return A success value.
         */
        virtual GHOST_TSuccess exit();
        
        /**
         * Converts raw WIN32 key codes from the wndproc to GHOST keys.
-        * @param window->      The window for this handling
-        * @param vKey          The virtual key from hardKey
-        * @param ScanCode      The ScanCode of pressed key (simular to PS/2 Set 1)
-        * @param extend        Flag if key is not primerly (left or right)
-        * @return The GHOST key (GHOST_kKeyUnknown if no match).
+        * \param window->      The window for this handling
+        * \param vKey          The virtual key from hardKey
+        * \param ScanCode      The ScanCode of pressed key (simular to PS/2 Set 1)
+        * \param extend        Flag if key is not primerly (left or right)
+        * \return The GHOST key (GHOST_kKeyUnknown if no match).
         */
        virtual GHOST_TKey convertKey(GHOST_IWindow *window, short vKey, short ScanCode, short extend) const;
 
        /**
         * Catches raw WIN32 key codes from WM_INPUT in the wndproc.
-        * @param window        The window for this handling
-        * @param raw           RawInput structure with detailed info about the key event
-        * @param keyDown       Pointer flag that specify if a key is down
-        * @param vk            Pointer to virtual key
-        * @return The GHOST key (GHOST_kKeyUnknown if no match).
+        * \param window        The window for this handling
+        * \param raw           RawInput structure with detailed info about the key event
+        * \param keyDown       Pointer flag that specify if a key is down
+        * \param vk            Pointer to virtual key
+        * \return The GHOST key (GHOST_kKeyUnknown if no match).
         */
        virtual GHOST_TKey hardKey(GHOST_IWindow *window, RAWINPUT const& raw, int *keyDown, char *vk);
 
@@ -246,32 +246,32 @@ protected:
         * With the modifier keys, we want to distinguish left and right keys.
         * Sometimes this is not possible (Windows ME for instance). Then, we want
         * events generated for both keys.
-        * @param window        The window receiving the event (the active window).
+        * \param window        The window receiving the event (the active window).
         */
        GHOST_EventKey *processModifierKeys(GHOST_IWindow *window);
 
        /**
         * Creates mouse button event.
-        * @param type          The type of event to create.
-        * @param window        The window receiving the event (the active window).
-        * @param mask          The button mask of this event.
-        * @return The event created.
+        * \param type          The type of event to create.
+        * \param window        The window receiving the event (the active window).
+        * \param mask          The button mask of this event.
+        * \return The event created.
         */
        static GHOST_EventButton *processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
 
        /**
         * Creates cursor event.
-        * @param type          The type of event to create.
-        * @param window        The window receiving the event (the active window).
-        * @return The event created.
+        * \param type          The type of event to create.
+        * \param window        The window receiving the event (the active window).
+        * \return The event created.
         */
        static GHOST_EventCursor *processCursorEvent(GHOST_TEventType type, GHOST_IWindow *Iwindow);
 
        /**
         * Creates a mouse wheel event.
-        * @param window        The window receiving the event (the active window).
-        * @param wParam        The wParam from the wndproc
-        * @param lParam        The lParam from the wndproc
+        * \param window        The window receiving the event (the active window).
+        * \param wParam        The wParam from the wndproc
+        * \param lParam        The lParam from the wndproc
         */
        static GHOST_EventWheel *processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);
 
@@ -279,31 +279,31 @@ protected:
         * Creates a key event and updates the key data stored locally (m_modifierKeys).
         * In most cases this is a straightforward conversion of key codes.
         * For the modifier keys however, we want to distinguish left and right keys.
-        * @param window        The window receiving the event (the active window).
-        * @param raw           RawInput structure with detailed info about the key event
+        * \param window        The window receiving the event (the active window).
+        * \param raw           RawInput structure with detailed info about the key event
         */
        static GHOST_EventKey *processKeyEvent(GHOST_IWindow *window, RAWINPUT const& raw);
 
        /**
         * Process special keys (VK_OEM_*), to see if current key layout
         * gives us anything special, like ! on french AZERTY.
-        * @param window        The window receiving the event (the active window).
-        * @param vKey          The virtual key from hardKey
-        * @param ScanCode      The ScanCode of pressed key (simular to PS/2 Set 1)
+        * \param window        The window receiving the event (the active window).
+        * \param vKey          The virtual key from hardKey
+        * \param ScanCode      The ScanCode of pressed key (simular to PS/2 Set 1)
         */
        virtual GHOST_TKey processSpecialKey(GHOST_IWindow *window, short vKey, short scanCode) const;
 
        /** 
         * Creates a window event.
-        * @param type          The type of event to create.
-        * @param window        The window receiving the event (the active window).
-        * @return The event created.
+        * \param type          The type of event to create.
+        * \param window        The window receiving the event (the active window).
+        * \return The event created.
         */
        static GHOST_Event *processWindowEvent(GHOST_TEventType type, GHOST_IWindow *window);
 
        /**
         * Handles minimum window size.
-        * @param minmax        The MINMAXINFO structure.
+        * \param minmax        The MINMAXINFO structure.
         */
        static void processMinMaxInfo(MINMAXINFO *minmax);
 
@@ -312,22 +312,22 @@ protected:
         * Handles Motion and Button events from a SpaceNavigator or related device.
         * Instead of returning an event object, this function communicates directly
         * with the GHOST_NDOFManager.
-        * @param raw           RawInput structure with detailed info about the NDOF event
-        * @return Whether an event was generated and sent.
+        * \param raw           RawInput structure with detailed info about the NDOF event
+        * \return Whether an event was generated and sent.
         */
        bool processNDOF(RAWINPUT const& raw);
 #endif
 
        /**
         * Returns the local state of the modifier keys (from the message queue).
-        * @param keys The state of the keys.
+        * \param keys The state of the keys.
         */
        inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
 
        /**
         * Stores the state of the modifier keys locally.
         * For internal use only!
-        * @param keys The new state of the modifier keys.
+        * param keys The new state of the modifier keys.
         */
        inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
        
@@ -343,12 +343,13 @@ protected:
 
        /**
         * Toggles console
-        * @action      0 - Hides
-        *                      1 - Shows
-        *                      2 - Toggles
-        *                      3 - Hides if it runs not from  command line
-        *                      * - Does nothing
-        * @return current status (1 -visible, 0 - hidden)
+        * \param action
+        * - 0 - Hides
+        * - 1 - Shows
+        * - 2 - Toggles
+        * - 3 - Hides if it runs not from  command line
+        * - * - Does nothing
+        * \return current status (1 -visible, 0 - hidden)
         */
        int toggleConsole(int action);
        
index 7ac9b0c..e75ecfb 100644 (file)
@@ -203,7 +203,7 @@ getNumDisplays() const
 
 /**
  * Returns the dimensions of the main display on this system.
- * @return The dimension of the main display.
+ * \return The dimension of the main display.
  */
 void
 GHOST_SystemX11::
@@ -221,17 +221,17 @@ getMainDisplayDimensions(
  * Create a new window.
  * The new window is added to the list of windows managed.
  * Never explicitly delete the window, use disposeWindow() instead.
- * @param      title   The name of the window (displayed in the title bar of the window if the OS supports it).
- * @param      left    The coordinate of the left edge of the window.
- * @param      top             The coordinate of the top edge of the window.
- * @param      width   The width the window.
- * @param      height  The height the window.
- * @param      state   The state of the window when opened.
- * @param      type    The type of drawing context installed in this window.
- * @param      stereoVisual    Stereo visual for quad buffered stereo.
- * @param      numOfAASamples  Number of samples used for AA (zero if no AA)
- * @param      parentWindow    Parent (embedder) window
- * @return     The new window (or 0 if creation failed).
+ * \param      title   The name of the window (displayed in the title bar of the window if the OS supports it).
+ * \param      left    The coordinate of the left edge of the window.
+ * \param      top             The coordinate of the top edge of the window.
+ * \param      width   The width the window.
+ * \param      height  The height the window.
+ * \param      state   The state of the window when opened.
+ * \param      type    The type of drawing context installed in this window.
+ * \param      stereoVisual    Stereo visual for quad buffered stereo.
+ * \param      numOfAASamples  Number of samples used for AA (zero if no AA)
+ * \param      parentWindow    Parent (embedder) window
+ * \return     The new window (or 0 if creation failed).
  */
 GHOST_IWindow *
 GHOST_SystemX11::
index d86790e..92bffe4 100644 (file)
@@ -49,9 +49,9 @@ class GHOST_WindowX11;
 
 /**
  * X11 Implementation of GHOST_System class.
- * @see GHOST_System.
- * @author     Laurence Bourn
- * @date       October 26, 2001
+ * \see GHOST_System.
+ * \author     Laurence Bourn
+ * \date       October 26, 2001
  */
 
 class GHOST_SystemX11 : public GHOST_System {
@@ -77,13 +77,13 @@ public:
 
 
        /**
-        * @section Interface Inherited from GHOST_ISystem 
+        * \section Interface Inherited from GHOST_ISystem
         */
 
        /**
         * Returns the system time.
         * Returns the number of milliseconds since the start of the system process.
-        * @return The number of milliseconds.
+        * \return The number of milliseconds.
         */
        GHOST_TUns64
        getMilliSeconds(
@@ -92,7 +92,7 @@ public:
 
        /**
         * Returns the number of displays on this system.
-        * @return The number of displays.
+        * \return The number of displays.
         */
        GHOST_TUns8
        getNumDisplays(
@@ -100,7 +100,7 @@ public:
 
        /**
         * Returns the dimensions of the main display on this system.
-        * @return The dimension of the main display.
+        * \return The dimension of the main display.
         */
        void
        getMainDisplayDimensions(
@@ -112,16 +112,16 @@ public:
         * Create a new window.
         * The new window is added to the list of windows managed. 
         * Never explicitly delete the window, use disposeWindow() instead.
-        * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
-        * @param       left            The coordinate of the left edge of the window.
-        * @param       top             The coordinate of the top edge of the window.
-        * @param       width           The width the window.
-        * @param       height          The height the window.
-        * @param       state           The state of the window when opened.
-        * @param       type            The type of drawing context installed in this window.
-        * @param       stereoVisual    Create a stereo visual for quad buffered stereo.
-        * @param       parentWindow    Parent (embedder) window
-        * @return      The new window (or 0 if creation failed).
+        * \param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
+        * \param       left            The coordinate of the left edge of the window.
+        * \param       top             The coordinate of the top edge of the window.
+        * \param       width           The width the window.
+        * \param       height          The height the window.
+        * \param       state           The state of the window when opened.
+        * \param       type            The type of drawing context installed in this window.
+        * \param       stereoVisual    Create a stereo visual for quad buffered stereo.
+        * \param       parentWindow    Parent (embedder) window
+        * \return      The new window (or 0 if creation failed).
         */
        GHOST_IWindow *
        createWindow(
@@ -138,13 +138,13 @@ public:
            );
 
        /**
-        * @section Interface Inherited from GHOST_ISystem 
+        * \section Interface Inherited from GHOST_ISystem
         */
 
        /**
         * Retrieves events from the system and stores them in the queue.
-        * @param waitForEvent Flag to wait for an event (or return immediately).
-        * @return Indication of the presence of events.
+        * \param waitForEvent Flag to wait for an event (or return immediately).
+        * \return Indication of the presence of events.
         */
        bool
        processEvents(
@@ -152,7 +152,7 @@ public:
            );
 
        /**
-        * @section Interface Inherited from GHOST_System 
+        * \section Interface Inherited from GHOST_System
         */
        GHOST_TSuccess
        getCursorPosition(
@@ -168,8 +168,8 @@ public:
 
        /**
         * Returns the state of all modifier keys.
-        * @param keys  The state of all modifier keys (true == pressed).
-        * @return              Indication of success.
+        * \param keys  The state of all modifier keys (true == pressed).
+        * \return              Indication of success.
         */
        GHOST_TSuccess
        getModifierKeys(
@@ -178,8 +178,8 @@ public:
 
        /**
         * Returns the state of the mouse buttons (ouside the message queue).
-        * @param buttons       The state of the buttons.
-        * @return                      Indication of success.
+        * \param buttons       The state of the buttons.
+        * \return                      Indication of success.
         */
        GHOST_TSuccess
        getButtons(
@@ -187,7 +187,7 @@ public:
            ) const;
 
        /**
-        * @section Interface Dirty
+        * \section Interface Dirty
         * Flag a window as dirty. This will
         * generate a GHOST window update event on a call to processEvents() 
         */
@@ -223,15 +223,15 @@ public:
 
        /**
         * Returns unsinged char from CUT_BUFFER0
-        * @param selection             Get selection, X11 only feature
-        * @return                              Returns the Clipboard indicated by Flag
+        * \param selection             Get selection, X11 only feature
+        * \return                              Returns the Clipboard indicated by Flag
         */
        GHOST_TUns8 *getClipboard(bool selection) const;
        
        /**
         * Puts buffer to system clipboard
-        * @param buffer        The buffer to copy to the clipboard     
-        * @param selection     Set the selection into the clipboard, X11 only feature
+        * \param buffer        The buffer to copy to the clipboard     
+        * \param selection     Set the selection into the clipboard, X11 only feature
         */
        void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
 
@@ -239,18 +239,18 @@ public:
        /**
         * Creates a drag'n'drop event and pushes it immediately onto the event queue. 
         * Called by GHOST_DropTargetX11 class.
-        * @param eventType The type of drag'n'drop event
-        * @param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
-        * @param mouseX x mouse coordinate (in window coordinates)
-        * @param mouseY y mouse coordinate
-        * @param window The window on which the event occurred
-        * @return Indication whether the event was handled. 
+        * \param eventType The type of drag'n'drop event
+        * \param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
+        * \param mouseX x mouse coordinate (in window coordinates)
+        * \param mouseY y mouse coordinate
+        * \param window The window on which the event occurred
+        * \return Indication whether the event was handled. 
         */
        static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType, GHOST_IWindow *window, int mouseX, int mouseY, void *data);
 #endif
 
        /**
-        * @see GHOST_ISystem
+        * \see GHOST_ISystem
         */
        int toggleConsole(int action) {
                return 0;
index 4ad28d6..b118650 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 31, 2001
+ * \author     Maarten Gribnau
+ * \date       May 31, 2001
  */
 
 #include "GHOST_TimerManager.h"
index 88d2708..5a24c56 100644 (file)
@@ -44,8 +44,8 @@ class GHOST_TimerTask;
  * Manages a list of timer tasks.
  * Timer tasks added are owned by the manager.
  * Don't delete timer task objects.
- * @author     Maarten Gribnau
- * @date       May 31, 2001
+ * \author     Maarten Gribnau
+ * \date       May 31, 2001
  */
 class GHOST_TimerManager
 {
@@ -62,51 +62,51 @@ public:
 
        /**
         * Returns the number of timer tasks.
-        * @return The number of events on the stack.
+        * \return The number of events on the stack.
         */
        virtual GHOST_TUns32 getNumTimers();
 
        /**
         * Returns whther this timer task ins in our list.
-        * @return Indication of presence.
+        * \return Indication of presence.
         */
        virtual bool getTimerFound(GHOST_TimerTask *timer);
 
        /**
         * Adds a timer task to the list.
         * It is only added when it not already present in the list.
-        * @param timer The timer task added to the list.
-        * @return Indication as to whether addition has succeeded.
+        * \param timer The timer task added to the list.
+        * \return Indication as to whether addition has succeeded.
         */
        virtual GHOST_TSuccess addTimer(GHOST_TimerTask *timer);
 
        /**
         * Removes a timer task from the list.
         * It is only removed when it is found in the list.
-        * @param timer The timer task to be removed from the list.
-        * @return Indication as to whether removal has succeeded.
+        * \param timer The timer task to be removed from the list.
+        * \return Indication as to whether removal has succeeded.
         */
        virtual GHOST_TSuccess removeTimer(GHOST_TimerTask *timer);
 
        /**
         * Finds the soonest time the next timer would fire.
-        * @return The soonest time the next timer would fire, 
+        * \return The soonest time the next timer would fire, 
         * or GHOST_kFireTimeNever if no timers exist.
         */
        virtual GHOST_TUns64 nextFireTime();
        
        /**
         * Checks all timer tasks to see if they are expired and fires them if needed.
-        * @param time The current time.
-        * @return True if any timers were fired.
+        * \param time The current time.
+        * \return True if any timers were fired.
         */
        virtual bool fireTimers(GHOST_TUns64 time);
 
        /**
         * Checks this timer task to see if they are expired and fires them if needed.
-        * @param time The current time.
-        * @param task The timer task to check and optionally fire.
-        * @return True if the timer fired.
+        * \param time The current time.
+        * \param task The timer task to check and optionally fire.
+        * \return True if the timer fired.
         */
        virtual bool fireTimer(GHOST_TUns64 time, GHOST_TimerTask *task);
 
index d74d705..0731bc0 100644 (file)
 
 /**
  * Implementation of a timer task.
- * @author     Maarten Gribnau
- * @date       May 28, 2001
+ * \author     Maarten Gribnau
+ * \date       May 28, 2001
  */
 class GHOST_TimerTask : public GHOST_ITimerTask
 {
 public:
        /**
         * Constructor.
-        * @param start         The timer start time.
-        * @param interval      The interval between calls to the timerProc
-        * @param timerProc     The callbak invoked when the interval expires.
-        * @param data          The timer user data.
+        * \param start         The timer start time.
+        * \param interval      The interval between calls to the timerProc
+        * \param timerProc     The callbak invoked when the interval expires.
+        * \param data          The timer user data.
         */
        GHOST_TimerTask(GHOST_TUns64 start,
                        GHOST_TUns64 interval,
@@ -66,7 +66,7 @@ public:
 
        /**
         * Returns the timer start time.
-        * @return The timer start time.
+        * \return The timer start time.
         */
        inline virtual GHOST_TUns64 getStart() const
        {
@@ -75,7 +75,7 @@ public:
 
        /**
         * Changes the timer start time.
-        * @param start The timer start time.
+        * \param start The timer start time.
         */
        virtual void setStart(GHOST_TUns64 start)
        { 
@@ -84,7 +84,7 @@ public:
 
        /**
         * Returns the timer interval.
-        * @return The timer interval.
+        * \return The timer interval.
         */
        inline virtual GHOST_TUns64 getInterval() const
        {
@@ -93,7 +93,7 @@ public:
 
        /**
         * Changes the timer interval.
-        * @param interval The timer interval.
+        * \param interval The timer interval.
         */
        virtual void setInterval(GHOST_TUns64 interval)
        { 
@@ -102,7 +102,7 @@ public:
 
        /**
         * Returns the time the timerProc will be called.
-        * @return The time the timerProc will be called.
+        * \return The time the timerProc will be called.
         */
        inline virtual GHOST_TUns64 getNext() const
        {
@@ -111,7 +111,7 @@ public:
 
        /**
         * Changes the time the timerProc will be called.
-        * @param next The time the timerProc will be called.
+        * \param next The time the timerProc will be called.
         */
        virtual void setNext(GHOST_TUns64 next)
        { 
@@ -120,7 +120,7 @@ public:
 
        /**
         * Returns the timer callback.
-        * @return the timer callback.
+        * \return the timer callback.
         */
        inline virtual GHOST_TimerProcPtr getTimerProc() const
        {
@@ -129,7 +129,7 @@ public:
 
        /**
         * Changes the timer callback.
-        * @param The timer callback.
+        * \param The timer callback.
         */
        inline virtual void setTimerProc(const GHOST_TimerProcPtr timerProc)
        {
@@ -138,7 +138,7 @@ public:
 
        /**
         * Returns the timer user data.
-        * @return The timer user data.
+        * \return The timer user data.
         */
        inline virtual GHOST_TUserDataPtr getUserData() const
        {
@@ -147,7 +147,7 @@ public:
        
        /**
         * Changes the time user data.
-        * @param data The timer user data.
+        * \param data The timer user data.
         */
        virtual void setUserData(const GHOST_TUserDataPtr userData)
        {
@@ -156,7 +156,7 @@ public:
 
        /**
         * Returns the auxiliary storage room.
-        * @return The auxiliary storage room.
+        * \return The auxiliary storage room.
         */
        inline virtual GHOST_TUns32 getAuxData() const
        {
@@ -165,7 +165,7 @@ public:
 
        /**
         * Changes the auxiliary storage room.
-        * @param auxData The auxiliary storage room.
+        * \param auxData The auxiliary storage room.
         */
        virtual void setAuxData(GHOST_TUns32 auxData)
        { 
index c3244d1..eb80a07 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 10, 2001
+ * \author     Maarten Gribnau
+ * \date       May 10, 2001
  */
 
 #include "GHOST_Window.h"
index 10a6a57..3043b10 100644 (file)
@@ -43,14 +43,14 @@ class STR_String;
  * upper-left corner of the screen.
  * Implements part of the GHOST_IWindow interface and adds some methods to
  * be implemented by childs of this class.
- * @author     Maarten Gribnau
- * @date       May 7, 2001
+ * \author     Maarten Gribnau
+ * \date       May 7, 2001
  */
 class GHOST_Window : public GHOST_IWindow
 {
 public:
        /**
-        * @section Interface inherited from GHOST_IWindow left for derived class
+        * \section Interface inherited from GHOST_IWindow left for derived class
         * implementation.
         * virtual      bool getValid() const = 0;
         * virtual void setTitle(const STR_String& title) = 0;
@@ -75,12 +75,12 @@ public:
         * Constructor.
         * Creates a new window and opens it.
         * To check if the window was created properly, use the getValid() method.
-        * @param width                         The width the window.
-        * @param heigh                         The height the window.
-        * @param state                         The state the window is initially opened with.
-        * @param type                          The type of drawing context installed in this window.
-        * @param stereoVisual          Stereo visual for quad buffered stereo.
-        * @param numOfAASamples        Number of samples used for AA (zero if no AA)
+        * \param width                         The width the window.
+        * \param heigh                         The height the window.
+        * \param state                         The state the window is initially opened with.
+        * \param type                          The type of drawing context installed in this window.
+        * \param stereoVisual          Stereo visual for quad buffered stereo.
+        * \param numOfAASamples        Number of samples used for AA (zero if no AA)
         */
        GHOST_Window(
            GHOST_TUns32 width,
@@ -91,7 +91,7 @@ public:
            const GHOST_TUns16 numOfAASamples = 0);
 
        /**
-        * @section Interface inherited from GHOST_IWindow left for derived class
+        * \section Interface inherited from GHOST_IWindow left for derived class
         * implementation.
         * virtual      bool getValid() const = 0;
         * virtual void setTitle(const STR_String& title) = 0;
@@ -119,30 +119,30 @@ public:
 
        /**
         * Returns the associated OS object/handle
-        * @return The associated OS object/handle
+        * \return The associated OS object/handle
         */
        virtual void *getOSWindow() const;
        
        /**
         * Returns the current cursor shape.
-        * @return      The current cursor shape.
+        * \return      The current cursor shape.
         */
        inline virtual GHOST_TStandardCursor getCursorShape() const;
 
        /**
         * Set the shape of the cursor.
-        * @param       cursor  The new cursor shape type id.
-        * @return      Indication of success.
+        * \param       cursor  The new cursor shape type id.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape);
 
        /**
         * Set the shape of the cursor to a custom cursor.
-        * @param       bitmap  The bitmap data for the cursor.
-        * @param       mask    The mask data for the cursor.
-        * @param       hotX    The X coordinate of the cursor hotspot.
-        * @param       hotY    The Y coordinate of the cursor hotspot.
-        * @return      Indication of success.
+        * \param       bitmap  The bitmap data for the cursor.
+        * \param       mask    The mask data for the cursor.
+        * \param       hotX    The X coordinate of the cursor hotspot.
+        * \param       hotY    The Y coordinate of the cursor hotspot.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess setCustomCursorShape(GHOST_TUns8 bitmap[16][2], 
                                                    GHOST_TUns8 mask[16][2],
@@ -157,7 +157,7 @@ public:
        
        /**
         * Returns the visibility state of the cursor.
-        * @return      The visibility state of the cursor.
+        * \return      The visibility state of the cursor.
         */
        inline virtual bool getCursorVisibility() const;
        inline virtual GHOST_TGrabCursorMode getCursorGrabMode() const;
@@ -168,15 +168,15 @@ public:
 
        /**
         * Shows or hides the cursor.
-        * @param       visible The new visibility state of the cursor.
-        * @return      Indication of success.
+        * \param       visible The new visibility state of the cursor.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess setCursorVisibility(bool visible);
 
        /**
         * Sets the cursor grab.
-        * @param       mode The new grab state of the cursor.
-        * @return      Indication of success.
+        * \param       mode The new grab state of the cursor.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess setCursorGrab(GHOST_TGrabCursorMode mode, GHOST_Rect *bounds);
 
@@ -188,7 +188,7 @@ public:
 
        /**
         * Sets the progress bar value displayed in the window/application icon
-        * @param progress The progress % (0.0 to 1.0)
+        * \param progress The progress % (0.0 to 1.0)
         */
        virtual GHOST_TSuccess setProgressBar(float progress) {
                return GHOST_kFailure;
@@ -214,20 +214,20 @@ public:
        
        /**
         * Sets the window "modified" status, indicating unsaved changes
-        * @param isUnsavedChanges Unsaved changes or not
-        * @return Indication of success.
+        * \param isUnsavedChanges Unsaved changes or not
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
        
        /**
         * Gets the window "modified" status, indicating unsaved changes
-        * @return True if there are unsaved changes
+        * \return True if there are unsaved changes
         */
        virtual bool getModifiedState();
        
        /**
         * Returns the type of drawing context used in this window.
-        * @return The current type of drawing context.
+        * \return The current type of drawing context.
         */
        inline virtual GHOST_TDrawingContextType getDrawingContextType();
 
@@ -235,14 +235,14 @@ public:
         * Tries to install a rendering context in this window.
         * Child classes do not need to overload this method.
         * They should overload the installDrawingContext and removeDrawingContext instead.
-        * @param type  The type of rendering context installed.
-        * @return Indication as to whether installation has succeeded.
+        * \param type  The type of rendering context installed.
+        * \return Indication as to whether installation has succeeded.
         */
        virtual GHOST_TSuccess setDrawingContextType(GHOST_TDrawingContextType type);
 
        /**
         * Returns the window user data.
-        * @return The window user data.
+        * \return The window user data.
         */
        inline virtual GHOST_TUserDataPtr getUserData() const
        {
@@ -251,7 +251,7 @@ public:
        
        /**
         * Changes the window user data.
-        * @param data The window user data.
+        * \param data The window user data.
         */
        virtual void setUserData(const GHOST_TUserDataPtr userData)
        {
@@ -261,14 +261,14 @@ public:
 protected:
        /**
         * Tries to install a rendering context in this window.
-        * @param type  The type of rendering context installed.
-        * @return Indication as to whether installation has succeeded.
+        * \param type  The type of rendering context installed.
+        * \return Indication as to whether installation has succeeded.
         */
        virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type) = 0;
 
        /**
         * Removes the current drawing context.
-        * @return Indication as to whether removal has succeeded.
+        * \return Indication as to whether removal has succeeded.
         */
        virtual GHOST_TSuccess removeDrawingContext() = 0;
 
index ca33660..c7be02c 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 10, 2001
+ * \author     Maarten Gribnau
+ * \date       May 10, 2001
  */
 
 #include "GHOST_WindowCarbon.h"
index 1291fb1..d25d571 100644 (file)
@@ -54,8 +54,8 @@
  * which is called the gutter.
  * When OpenGL contexts are active, GHOST will use AGL_BUFFER_RECT to prevent
  * OpenGL drawing outside the reduced client rectangle.
- * @author     Maarten Gribnau
- * @date       May 23, 2001
+ * \author     Maarten Gribnau
+ * \date       May 23, 2001
  */
 class GHOST_WindowCarbon : public GHOST_Window {
 public:
@@ -63,14 +63,14 @@ public:
         * Constructor.
         * Creates a new window and opens it.
         * To check if the window was created properly, use the getValid() method.
-        * @param title         The text shown in the title bar of the window.
-        * @param left          The coordinate of the left edge of the window.
-        * @param top           The coordinate of the top edge of the window.
-        * @param width         The width the window.
-        * @param height        The height the window.
-        * @param state         The state the window is initially opened with.
-        * @param type          The type of drawing context installed in this window.
-        * @param stereoVisual  Stereo visual for quad buffered stereo.
+        * \param title         The text shown in the title bar of the window.
+        * \param left          The coordinate of the left edge of the window.
+        * \param top           The coordinate of the top edge of the window.
+        * \param width         The width the window.
+        * \param height        The height the window.
+        * \param state         The state the window is initially opened with.
+        * \param type          The type of drawing context installed in this window.
+        * \param stereoVisual  Stereo visual for quad buffered stereo.
         */
        GHOST_WindowCarbon(
            const STR_String& title,
@@ -92,109 +92,109 @@ public:
 
        /**
         * Returns indication as to whether the window is valid.
-        * @return The validity of the window.
+        * \return The validity of the window.
         */
        virtual bool getValid() const;
 
        /**
         * Sets the title displayed in the title bar.
-        * @param title The title to display in the title bar.
+        * \param title The title to display in the title bar.
         */
        virtual void setTitle(const STR_String& title);
 
        /**
         * Returns the title displayed in the title bar.
-        * @param title The title displayed in the title bar.
+        * \param title The title displayed in the title bar.
         */
        virtual void getTitle(STR_String& title) const;
 
        /**
         * Returns the window rectangle dimensions.
         * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
-        * @param bounds The bounding rectangle of the window.
+        * \param bounds The bounding rectangle of the window.
         */
        virtual void getWindowBounds(GHOST_Rect& bounds) const;
        
        /**
         * Returns the client rectangle dimensions.
         * The left and top members of the rectangle are always zero.
-        * @param bounds The bounding rectangle of the cleient area of the window.
+        * \param bounds The bounding rectangle of the cleient area of the window.
         */
        virtual void getClientBounds(GHOST_Rect& bounds) const;
 
        /**
         * Resizes client rectangle width.
-        * @param width The new width of the client area of the window.
+        * \param width The new width of the client area of the window.
         */
        virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
 
        /**
         * Resizes client rectangle height.
-        * @param height The new height of the client area of the window.
+        * \param height The new height of the client area of the window.
         */
        virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
 
        /**
         * Resizes client rectangle.
-        * @param width         The new width of the client area of the window.
-        * @param height        The new height of the client area of the window.
+        * \param width         The new width of the client area of the window.
+        * \param height        The new height of the client area of the window.
         */
        virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
 
        /**
         * Returns the state of the window (normal, minimized, maximized).
-        * @return The state of the window.
+        * \return The state of the window.
         */
        virtual GHOST_TWindowState getState() const;
 
        /**
         * Converts a point in screen coordinates to client rectangle coordinates
-        * @param inX   The x-coordinate on the screen.
-        * @param inY   The y-coordinate on the screen.
-        * @param outX  The x-coordinate in the client rectangle.
-        * @param outY  The y-coordinate in the client rectangle.
+        * \param inX   The x-coordinate on the screen.
+        * \param inY   The y-coordinate on the screen.
+        * \param outX  The x-coordinate in the client rectangle.
+        * \param outY  The y-coordinate in the client rectangle.
         */
        virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 
        /**
         * Converts a point in screen coordinates to client rectangle coordinates
-        * @param inX   The x-coordinate in the client rectangle.
-        * @param inY   The y-coordinate in the client rectangle.
-        * @param outX  The x-coordinate on the screen.
-        * @param outY  The y-coordinate on the screen.
+        * \param inX   The x-coordinate in the client rectangle.
+        * \param inY   The y-coordinate in the client rectangle.
+        * \param outX  The x-coordinate on the screen.
+        * \param outY  The y-coordinate on the screen.
         */
        virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 
        /**
         * Sets the state of the window (normal, minimized, maximized).
-        * @param state The state of the window.
-        * @return Indication of success.
+        * \param state The state of the window.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setState(GHOST_TWindowState state);
 
        /**
         * Sets the order of the window (bottom, top).
-        * @param order The order of the window.
-        * @return Indication of success.
+        * \param order The order of the window.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
 
        /**
         * Swaps front and back buffers of a window.
-        * @return      A boolean success indicator.
+        * \return      A boolean success indicator.
         */
        virtual GHOST_TSuccess swapBuffers();
 
        /**
         * Updates the drawing context of this window. Needed
         * whenever the window is changed.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        GHOST_TSuccess updateDrawingContext();
 
        /**
         * Activates the drawing context of this window.
-        * @return      A boolean success indicator.
+        * \return      A boolean success indicator.
         */
        virtual GHOST_TSuccess activateDrawingContext();
 
@@ -202,7 +202,7 @@ public:
 
        /**
         * Returns the dirty state of the window when in full-screen mode.
-        * @return Whether it is dirty.
+        * \return Whether it is dirty.
         */
        virtual bool getFullScreenDirty();
 
@@ -223,20 +223,20 @@ public:
 protected:
        /**
         * Tries to install a rendering context in this window.
-        * @param type  The type of rendering context installed.
-        * @return Indication as to whether installation has succeeded.
+        * \param type  The type of rendering context installed.
+        * \return Indication as to whether installation has succeeded.
         */
        virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
 
        /**
         * Removes the current drawing context.
-        * @return Indication as to whether removal has succeeded.
+        * \return Indication as to whether removal has succeeded.
         */
        virtual GHOST_TSuccess removeDrawingContext();
     
        /**
         * Invalidates the contents of this window.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess invalidate();
 
@@ -263,15 +263,15 @@ protected:
 
        /**
         * Converts a string object to a Mac Pascal string.
-        * @param in    The string object to be converted.
-        * @param out   The converted string.
+        * \param in    The string object to be converted.
+        * \param out   The converted string.
         */
        virtual void gen2mac(const STR_String& in, Str255 out) const;
 
        /**
         * Converts a Mac Pascal string to a string object.
-        * @param in    The string to be converted.
-        * @param out   The converted string object.
+        * \param in    The string to be converted.
+        * \param out   The converted string object.
         */
        virtual void mac2gen(const Str255 in, STR_String& out) const;
        
index d53dfa7..3e5c675 100644 (file)
@@ -53,8 +53,8 @@ class GHOST_SystemCocoa;
  * which is called the gutter.
  * When OpenGL contexts are active, GHOST will use AGL_BUFFER_RECT to prevent
  * OpenGL drawing outside the reduced client rectangle.
- * @author     Maarten Gribnau
- * @date       May 23, 2001
+ * \author     Maarten Gribnau
+ * \date       May 23, 2001
  */
 class GHOST_WindowCocoa : public GHOST_Window {
 public:
@@ -62,16 +62,16 @@ public:
         * Constructor.
         * Creates a new window and opens it.
         * To check if the window was created properly, use the getValid() method.
-        * @param systemCocoa           The associated system class to forward events to
-        * @param title                         The text shown in the title bar of the window.
-        * @param left                          The coordinate of the left edge of the window.
-        * @param top                           The coordinate of the top edge of the window.
-        * @param width                         The width the window.
-        * @param height                        The height the window.
-        * @param state                         The state the window is initially opened with.
-        * @param type                          The type of drawing context installed in this window.
-        * @param stereoVisual          Stereo visual for quad buffered stereo.
-        * @param numOfAASamples        Number of samples used for AA (zero if no AA)
+        * \param systemCocoa           The associated system class to forward events to
+        * \param title                         The text shown in the title bar of the window.
+        * \param left                          The coordinate of the left edge of the window.
+        * \param top                           The coordinate of the top edge of the window.
+        * \param width                         The width the window.
+        * \param height                        The height the window.
+        * \param state                         The state the window is initially opened with.
+        * \param type                          The type of drawing context installed in this window.
+        * \param stereoVisual          Stereo visual for quad buffered stereo.
+        * \param numOfAASamples        Number of samples used for AA (zero if no AA)
         */
        GHOST_WindowCocoa(
            GHOST_SystemCocoa *systemCocoa,
@@ -94,148 +94,148 @@ public:
 
        /**
         * Returns indication as to whether the window is valid.
-        * @return The validity of the window.
+        * \return The validity of the window.
         */
        virtual bool getValid() const;
        
        /**
         * Returns the associated NSWindow object
-        * @return The associated NSWindow object
+        * \return The associated NSWindow object
         */
        virtual void *getOSWindow() const;
 
        /**
         * Sets the title displayed in the title bar.
-        * @param title The title to display in the title bar.
+        * \param title The title to display in the title bar.
         */
        virtual void setTitle(const STR_String& title);
 
        /**
         * Returns the title displayed in the title bar.
-        * @param title The title displayed in the title bar.
+        * \param title The title displayed in the title bar.
         */
        virtual void getTitle(STR_String& title) const;
 
        /**
         * Returns the window rectangle dimensions.
         * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
-        * @param bounds The bounding rectangle of the window.
+        * \param bounds The bounding rectangle of the window.
         */
        virtual void getWindowBounds(GHOST_Rect& bounds) const;
        
        /**
         * Returns the client rectangle dimensions.
         * The left and top members of the rectangle are always zero.
-        * @param bounds The bounding rectangle of the cleient area of the window.
+        * \param bounds The bounding rectangle of the cleient area of the window.
         */
        virtual void getClientBounds(GHOST_Rect& bounds) const;
 
        /**
         * Resizes client rectangle width.
-        * @param width The new width of the client area of the window.
+        * \param width The new width of the client area of the window.
         */
        virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
 
        /**
         * Resizes client rectangle height.
-        * @param height The new height of the client area of the window.
+        * \param height The new height of the client area of the window.
         */
        virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
 
        /**
         * Resizes client rectangle.
-        * @param width         The new width of the client area of the window.
-        * @param height        The new height of the client area of the window.
+        * \param width         The new width of the client area of the window.
+        * \param height        The new height of the client area of the window.
         */
        virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
 
        /**
         * Returns the state of the window (normal, minimized, maximized).
-        * @return The state of the window.
+        * \return The state of the window.
         */
        virtual GHOST_TWindowState getState() const;
 
        /**
         * Sets the window "modified" status, indicating unsaved changes
-        * @param isUnsavedChanges Unsaved changes or not
-        * @return Indication of success.
+        * \param isUnsavedChanges Unsaved changes or not
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setModifiedState(bool isUnsavedChanges);
        
        /**
         * Converts a point in screen coordinates to client rectangle coordinates
-        * @param inX   The x-coordinate on the screen.
-        * @param inY   The y-coordinate on the screen.
-        * @param outX  The x-coordinate in the client rectangle.
-        * @param outY  The y-coordinate in the client rectangle.
+        * \param inX   The x-coordinate on the screen.
+        * \param inY   The y-coordinate on the screen.
+        * \param outX  The x-coordinate in the client rectangle.
+        * \param outY  The y-coordinate in the client rectangle.
         */
        virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 
        /**
         * Converts a point in screen coordinates to client rectangle coordinates
-        * @param inX   The x-coordinate in the client rectangle.
-        * @param inY   The y-coordinate in the client rectangle.
-        * @param outX  The x-coordinate on the screen.
-        * @param outY  The y-coordinate on the screen.
+        * \param inX   The x-coordinate in the client rectangle.
+        * \param inY   The y-coordinate in the client rectangle.
+        * \param outX  The x-coordinate on the screen.
+        * \param outY  The y-coordinate on the screen.
         */
        virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 
        /**
         * Converts a point in screen coordinates to client rectangle coordinates
         * but without the y coordinate conversion needed for ghost compatibility.
-        * @param inX   The x-coordinate in the client rectangle.
-        * @param inY   The y-coordinate in the client rectangle.
-        * @param outX  The x-coordinate on the screen.
-        * @param outY  The y-coordinate on the screen.
+        * \param inX   The x-coordinate in the client rectangle.
+        * \param inY   The y-coordinate in the client rectangle.
+        * \param outX  The x-coordinate on the screen.
+        * \param outY  The y-coordinate on the screen.
         */
        void clientToScreenIntern(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 
        /**
         * Converts a point in screen coordinates to client rectangle coordinates,
         * but without the y coordinate conversion needed for ghost compatibility.
-        * @param inX   The x-coordinate in the client rectangle.
-        * @param inY   The y-coordinate in the client rectangle.
-        * @param outX  The x-coordinate on the screen.
-        * @param outY  The y-coordinate on the screen.
+        * \param inX   The x-coordinate in the client rectangle.
+        * \param inY   The y-coordinate in the client rectangle.
+        * \param outX  The x-coordinate on the screen.
+        * \param outY  The y-coordinate on the screen.
         */
        void screenToClientIntern(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 
        /**
         * Gets the screen the window is displayed in
-        * @return The NSScreen object
+        * \return The NSScreen object
         */
        NSScreen *getScreen();
        
        /**
         * Sets the state of the window (normal, minimized, maximized).
-        * @param state The state of the window.
-        * @return Indication of success.
+        * \param state The state of the window.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setState(GHOST_TWindowState state);
 
        /**
         * Sets the order of the window (bottom, top).
-        * @param order The order of the window.
-        * @return Indication of success.
+        * \param order The order of the window.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
 
        /**
         * Swaps front and back buffers of a window.
-        * @return      A boolean success indicator.
+        * \return      A boolean success indicator.
         */
        virtual GHOST_TSuccess swapBuffers();
 
        /**
         * Updates the drawing context of this window. Needed
         * whenever the window is changed.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        GHOST_TSuccess updateDrawingContext();
 
        /**
         * Activates the drawing context of this window.
-        * @return      A boolean success indicator.
+        * \return      A boolean success indicator.
         */
        virtual GHOST_TSuccess activateDrawingContext();
 
@@ -254,7 +254,7 @@ public:
        
        /**
         * Sets the progress bar value displayed in the window/application icon
-        * @param progress The progress % (0.0 to 1.0)
+        * \param progress The progress % (0.0 to 1.0)
         */
        virtual GHOST_TSuccess setProgressBar(float progress);
        
@@ -265,20 +265,20 @@ public:
 protected:
        /**
         * Tries to install a rendering context in this window.
-        * @param type  The type of rendering context installed.
-        * @return Indication as to whether installation has succeeded.
+        * \param type  The type of rendering context installed.
+        * \return Indication as to whether installation has succeeded.
         */
        virtual GHOST_TSuccess installDrawingContext(GHOST_TDrawingContextType type);
 
        /**
         * Removes the current drawing context.
-        * @return Indication as to whether removal has succeeded.
+        * \return Indication as to whether removal has succeeded.
         */
        virtual GHOST_TSuccess removeDrawingContext();
     
        /**
         * Invalidates the contents of this window.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess invalidate();
 
index 294766c..3158900 100644 (file)
@@ -213,7 +213,7 @@ extern "C" {
        
        switch (m_draggedObjectType) {
                case GHOST_kDragnDropTypeBitmap:
-                       if([NSImage canInitWithPasteboard:draggingPBoard]) {
+                       if ([NSImage canInitWithPasteboard:draggingPBoard]) {
                                droppedImg = [[NSImage alloc]initWithPasteboard:draggingPBoard];
                                data = droppedImg; //[draggingPBoard dataForType:NSTIFFPboardType];
                        }
@@ -244,8 +244,8 @@ extern "C" {
        GHOST_SystemCocoa *systemCocoa;
        GHOST_WindowCocoa *associatedWindow;
 
-       bool composing;
-       NSString *composing_text;
+       bool composing;
+       NSString *composing_text;
 }
 - (void)setSystemAndWindowCocoa:(GHOST_SystemCocoa *)sysCocoa windowCocoa:(GHOST_WindowCocoa *)winCocoa;
 @end
@@ -256,34 +256,35 @@ extern "C" {
        systemCocoa = sysCocoa;
        associatedWindow = winCocoa;
 
-       composing = false;
-       composing_text = nil;
+       composing = false;
+       composing_text = nil;
 }
 
 - (BOOL)acceptsFirstResponder
 {
-    return YES;
+       return YES;
 }
 
 // The trick to prevent Cocoa from complaining (beeping)
 - (void)keyDown:(NSEvent *)event
 {
-       // Start or continue composing?
-       if([[event characters] length] == 0  ||
-          [[event charactersIgnoringModifiers] length] == 0 ||
-          composing) {
-               composing = YES;
-               // interpret event to call insertText
-               NSMutableArray *events;
-               events = [[NSMutableArray alloc] initWithCapacity:1];
-               [events addObject:event];
-               [self interpretKeyEvents:events]; // calls insertText
-               [events removeObject:event];
-               [events release];
+       /* Start or continue composing? */
+       if ([[event characters] length] == 0  ||
+           [[event charactersIgnoringModifiers] length] == 0 ||
+           composing)
+       {
+               composing = YES;
 
-               return;
-       }
+               // interpret event to call insertText
+               NSMutableArray *events;
+               events = [[NSMutableArray alloc] initWithCapacity:1];
+               [events addObject:event];
+               [self interpretKeyEvents:events]; // calls insertText
+               [events removeObject:event];
+               [events release];
+
+               return;
+       }
 }
 
 #if MAC_OS_X_VERSION_MIN_REQUIRED <= MAC_OS_X_VERSION_10_4
@@ -314,62 +315,60 @@ extern "C" {
 
 - (BOOL)isOpaque
 {
-    return YES;
+       return YES;
 }
 
 - (void) drawRect:(NSRect)rect
 {
-    if ([self inLiveResize])
-    {
-        //Don't redraw while in live resize
-    }
-    else
-    {
-        [super drawRect:rect];
-        systemCocoa->handleWindowEvent(GHOST_kEventWindowUpdate, associatedWindow);
-    }
+       if ([self inLiveResize]) {
+               /* Don't redraw while in live resize */
+       }
+       else {
+               [super drawRect:rect];
+               systemCocoa->handleWindowEvent(GHOST_kEventWindowUpdate, associatedWindow);
+       }
 }
 
 // Text input
 
 - (void)composing_free
 {
-       composing = NO;
+       composing = NO;
 
-       if(composing_text) {
-               [composing_text release];
-               composing_text = nil;
-       }
+       if (composing_text) {
+               [composing_text release];
+               composing_text = nil;
+       }
 }
 
 - (void)insertText:(id)chars
 {
-       [self composing_free];
+       [self composing_free];
 }
 
 - (void)setMarkedText:(id)chars selectedRange:(NSRange)range
 {
-       [self composing_free];
-       if([chars length] == 0)
-               return;
-       
-       // start composing
-       composing = YES;
-       composing_text = [chars copy];
+       [self composing_free];
+       if ([chars length] == 0)
+               return;
+
+       // start composing
+       composing = YES;
+       composing_text = [chars copy];
 
-       // if empty, cancel
-       if([composing_text length] == 0)
-               [self composing_free];
+       // if empty, cancel
+       if ([composing_text length] == 0)
+               [self composing_free];
 }
 
 - (void)unmarkText
 {
-       [self composing_free];
+       [self composing_free];
 }
 
 - (BOOL)hasMarkedText
 {
-       return (composing)? YES: NO;
+       return (composing)? YES: NO;
 }
 
 - (void)doCommandBySelector:(SEL)selector
@@ -378,48 +377,48 @@ extern "C" {
 
 - (BOOL)isComposing
 {
-       return composing;
+       return composing;
 }
 
 - (NSInteger)conversationIdentifier
 {
-       return (NSInteger)self;
+       return (NSInteger)self;
 }
 
 - (NSAttributedString *)attributedSubstringFromRange:(NSRange)range
 {
-       return [NSAttributedString new]; // XXX does this leak?
+       return [NSAttributedString new]; // XXX does this leak?
 }
 
 - (NSRange)markedRange
 {
-       unsigned int length = (composing_text)? [composing_text length]: 0;
+       unsigned int length = (composing_text)? [composing_text length]: 0;
 
-       if(composing)
-               return NSMakeRange(0, length);
+       if (composing)
+               return NSMakeRange(0, length);
 
-       return NSMakeRange(NSNotFound, 0);
+       return NSMakeRange(NSNotFound, 0);
 }
 
 - (NSRange)selectedRange
 {
-       unsigned int length = (composing_text)? [composing_text length]: 0;
-       return NSMakeRange(0, length);
+       unsigned int length = (composing_text)? [composing_text length]: 0;
+       return NSMakeRange(0, length);
 }
 
 - (NSRect)firstRectForCharacterRange:(NSRange)range
 {
-       return NSZeroRect;
+       return NSZeroRect;
 }
 
 - (NSUInteger)characterIndexForPoint:(NSPoint)point
 {
-       return NSNotFound;
+       return NSNotFound;
 }
 
 - (NSArray*)validAttributesForMarkedText
 {
-       return [NSArray array]; // XXX does this leak?
+       return [NSArray array]; // XXX does this leak?
 }
 
 @end
@@ -487,7 +486,7 @@ GHOST_WindowCocoa::GHOST_WindowCocoa(
        pixelFormatAttrsWindow[i++] = NSOpenGLPFABackingStore; 
        
        // Force software OpenGL, for debugging
-       if(getenv("BLENDER_SOFTWAREGL")) {
+       if (getenv("BLENDER_SOFTWAREGL")) {
                pixelFormatAttrsWindow[i++] = NSOpenGLPFARendererID;
                pixelFormatAttrsWindow[i++] = kCGLRendererGenericID;
        }
@@ -530,7 +529,7 @@ GHOST_WindowCocoa::GHOST_WindowCocoa(
                pixelFormatAttrsWindow[i++] = NSOpenGLPFABackingStore;
                
                // Force software OpenGL, for debugging
-               if(getenv("BLENDER_SOFTWAREGL")) {
+               if (getenv("BLENDER_SOFTWAREGL")) {
                        pixelFormatAttrsWindow[i++] = NSOpenGLPFARendererID;
                        pixelFormatAttrsWindow[i++] = kCGLRendererGenericID;
                }
@@ -600,7 +599,7 @@ GHOST_WindowCocoa::GHOST_WindowCocoa(
 
 GHOST_WindowCocoa::~GHOST_WindowCocoa()
 {
-    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+       NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
 
        if (m_customCursor) {
                [m_customCursor release];
@@ -638,14 +637,13 @@ void* GHOST_WindowCocoa::getOSWindow() const
 
 void GHOST_WindowCocoa::setTitle(const STR_String& title)
 {
-    GHOST_ASSERT(getValid(), "GHOST_WindowCocoa::setTitle(): window invalid")
+       GHOST_ASSERT(getValid(), "GHOST_WindowCocoa::setTitle(): window invalid")
        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
 
        NSString *windowTitle = [[NSString alloc] initWithCString:title encoding:NSUTF8StringEncoding];
        
        //Set associated file if applicable
-       if (windowTitle && [windowTitle hasPrefix:@"Blender"])
-       {
+       if (windowTitle && [windowTitle hasPrefix:@"Blender"]) {
                NSRange fileStrRange;
                NSString *associatedFileName;
                int len;
@@ -653,8 +651,7 @@ void GHOST_WindowCocoa::setTitle(const STR_String& title)
                fileStrRange.location = [windowTitle rangeOfString:@"["].location+1;
                len = [windowTitle rangeOfString:@"]"].location - fileStrRange.location;
        
-               if (len > 0)
-               {
+               if (len > 0) {
                        fileStrRange.length = len;
                        associatedFileName = [windowTitle substringWithRange:fileStrRange];
                        [m_window setTitle:[associatedFileName lastPathComponent]];
@@ -686,14 +683,14 @@ void GHOST_WindowCocoa::setTitle(const STR_String& title)
 
 void GHOST_WindowCocoa::getTitle(STR_String& title) const
 {
-    GHOST_ASSERT(getValid(), "GHOST_WindowCocoa::getTitle(): window invalid")
+       GHOST_ASSERT(getValid(), "GHOST_WindowCocoa::getTitle(): window invalid")
 
        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
 
        NSString *windowTitle = [m_window title];
 
        if (windowTitle != nil) {
-               title = [windowTitle UTF8String];               
+               title = [windowTitle UTF8String];
        }
        
        [pool drain];
@@ -727,8 +724,7 @@ void GHOST_WindowCocoa::getClientBounds(GHOST_Rect& bounds) const
        
        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
        
-       if (!m_fullScreen)
-       {
+       if (!m_fullScreen) {
                NSRect screenSize = [[m_window screen] visibleFrame];
 
                //Max window contents as screen size (excluding title bar...)
@@ -794,8 +790,9 @@ GHOST_TSuccess GHOST_WindowCocoa::setClientSize(GHOST_TUns32 width, GHOST_TUns32
        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
        GHOST_Rect cBnds, wBnds;
        getClientBounds(cBnds);
-       if ((((GHOST_TUns32)cBnds.getWidth()) != width) ||
-           (((GHOST_TUns32)cBnds.getHeight()) != height)) {
+       if ((((GHOST_TUns32)cBnds.getWidth())  != width) ||
+           (((GHOST_TUns32)cBnds.getHeight()) != height))
+       {
                NSSize size;
                size.width=width;
                size.height=height;
@@ -889,35 +886,36 @@ NSScreen* GHOST_WindowCocoa::getScreen()
 
 
 /**
- * @note Fullscreen switch is not actual fullscreen with display capture. As this capture removes all OS X window manager features.
+ * \note Fullscreen switch is not actual fullscreen with display capture.
+ * As this capture removes all OS X window manager features.
+ *
  * Instead, the menu bar and the dock are hidden, and the window is made borderless and enlarged.
  * Thus, process switch, exposé, spaces, ... still work in fullscreen mode
  */
 GHOST_TSuccess GHOST_WindowCocoa::setState(GHOST_TWindowState state)
 {
        GHOST_ASSERT(getValid(), "GHOST_WindowCocoa::setState(): window invalid")
-    switch (state) {
+       switch (state) {
                case GHOST_kWindowStateMinimized:
-            [m_window miniaturize:nil];
-            break;
+                       [m_window miniaturize:nil];
+                       break;
                case GHOST_kWindowStateMaximized:
                        [m_window zoom:nil];
                        break;
                
                case GHOST_kWindowStateFullScreen:
-                       if (!m_fullScreen)
-                       {
+                       if (!m_fullScreen) {
                                NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
                        
-                               //This status change needs to be done before Cocoa call to enter fullscreen mode
-                               //to give window delegate hint not to forward its deactivation to ghost wm that doesn't know view/window difference
+                               /* This status change needs to be done before Cocoa call to enter fullscreen mode
+                                * to give window delegate hint not to forward its deactivation to ghost wm that
+                                * doesn't know view/window difference. */
                                m_fullScreen = true;
 
 #ifdef MAC_OS_X_VERSION_10_6
                                //10.6 provides Cocoa functions to autoshow menu bar, and to change a window style
                                //Hide menu & dock if needed
-                               if ([[m_window screen] isEqual:[[NSScreen screens] objectAtIndex:0]])
-                               {
+                               if ([[m_window screen] isEqual:[[NSScreen screens] objectAtIndex:0]]) {
                                        [NSApp setPresentationOptions:(NSApplicationPresentationHideDock | NSApplicationPresentationAutoHideMenuBar)];
                                }
                                //Make window borderless and enlarge it
@@ -927,8 +925,7 @@ GHOST_TSuccess GHOST_WindowCocoa::setState(GHOST_TWindowState state)
 #else
                                //With 10.5, we need to create a new window to change its style to borderless
                                //Hide menu & dock if needed
-                               if ([[m_window screen] isEqual:[[NSScreen screens] objectAtIndex:0]])
-                               {
+                               if ([[m_window screen] isEqual:[[NSScreen screens] objectAtIndex:0]]) {
                                        //Cocoa function in 10.5 does not allow to set the menu bar in auto-show mode [NSMenu setMenuBarVisible:NO];
                                        //One of the very few 64bit compatible Carbon function
                                        SetSystemUIMode(kUIModeAllHidden,kUIOptionAutoShowMenuBar);
@@ -947,7 +944,7 @@ GHOST_TSuccess GHOST_WindowCocoa::setState(GHOST_TWindowState state)
                                [tmpWindow setDelegate:[m_window delegate]];
                                [tmpWindow setSystemAndWindowCocoa:[m_window systemCocoa] windowCocoa:this];
                                [tmpWindow registerForDraggedTypes:[NSArray arrayWithObjects:NSFilenamesPboardType,
-                                                                                                  NSStringPboardType, NSTIFFPboardType, nil]];
+                                                                   NSStringPboardType, NSTIFFPboardType, nil]];
                                
                                //Assign the openGL view to the new window
                                [tmpWindow setContentView:m_openGLView];
@@ -968,17 +965,15 @@ GHOST_TSuccess GHOST_WindowCocoa::setState(GHOST_TWindowState state)
                                }
                        break;
                case GHOST_kWindowStateNormal:
-        default:
+               default:
                        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
-                       if (m_fullScreen)
-                       {
+                       if (m_fullScreen) {
                                m_fullScreen = false;
 
                                //Exit fullscreen
 #ifdef MAC_OS_X_VERSION_10_6
                                //Show again menu & dock if needed
-                               if ([[m_window screen] isEqual:[NSScreen mainScreen]])
-                               {
+                               if ([[m_window screen] isEqual:[NSScreen mainScreen]]) {
                                        [NSApp setPresentationOptions:NSApplicationPresentationDefault];
                                }
                                //Make window normal and resize it
@@ -989,8 +984,7 @@ GHOST_TSuccess GHOST_WindowCocoa::setState(GHOST_TWindowState state)
 #else
                                //With 10.5, we need to create a new window to change its style to borderless
                                //Show menu & dock if needed
-                               if ([[m_window screen] isEqual:[NSScreen mainScreen]])
-                               {
+                               if ([[m_window screen] isEqual:[NSScreen mainScreen]]) {
                                        //Cocoa function in 10.5 does not allow to set the menu bar in auto-show mode [NSMenu setMenuBarVisible:YES];
                                        SetSystemUIMode(kUIModeNormal, 0); //One of the very few 64bit compatible Carbon function
                                }
@@ -1027,15 +1021,15 @@ GHOST_TSuccess GHOST_WindowCocoa::setState(GHOST_TWindowState state)
                                //Tell WM of view new size
                                m_systemCocoa->handleWindowEvent(GHOST_kEventWindowSize, this);
                        }
-            else if ([m_window isMiniaturized])
+                       else if ([m_window isMiniaturized])
                                [m_window deminiaturize:nil];
                        else if ([m_window isZoomed])
                                [m_window zoom:nil];
                        [pool drain];
-            break;
-    }
+                       break;
+       }
 
-    return GHOST_kSuccess;
+       return GHOST_kSuccess;
 }
 
 GHOST_TSuccess GHOST_WindowCocoa::setModifiedState(bool isUnsavedChanges)
@@ -1055,10 +1049,10 @@ GHOST_TSuccess GHOST_WindowCocoa::setOrder(GHOST_TWindowOrder order)
        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
        
        GHOST_ASSERT(getValid(), "GHOST_WindowCocoa::setOrder(): window invalid")
-    if (order == GHOST_kWindowOrderTop) {
+       if (order == GHOST_kWindowOrderTop) {
                [m_window makeKeyAndOrderFront:nil];
-    }
-    else {
+       }
+       else {
                NSArray *windowsList;
                
                [m_window orderBack:nil];
@@ -1068,10 +1062,10 @@ GHOST_TSuccess GHOST_WindowCocoa::setOrder(GHOST_TWindowOrder order)
                if ([windowsList count]) {
                        [[windowsList objectAtIndex:0] makeKeyAndOrderFront:nil];
                }
-    }
+       }
        
        [pool drain];
-    return GHOST_kSuccess;
+       return GHOST_kSuccess;
 }
 
 #pragma mark Drawing context
@@ -1080,15 +1074,15 @@ GHOST_TSuccess GHOST_WindowCocoa::setOrder(GHOST_TWindowOrder order)
 
 GHOST_TSuccess GHOST_WindowCocoa::swapBuffers()
 {
-    if (m_drawingContextType == GHOST_kDrawingContextTypeOpenGL) {
-        if (m_openGLContext != nil) {
+       if (m_drawingContextType == GHOST_kDrawingContextTypeOpenGL) {
+               if (m_openGLContext != nil) {
                        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
                        [m_openGLContext flushBuffer];
                        [pool drain];
-            return GHOST_kSuccess;
-        }
-    }
-    return GHOST_kFailure;
+                       return GHOST_kSuccess;
+               }
+       }
+       return GHOST_kFailure;
 }
 
 GHOST_TSuccess GHOST_WindowCocoa::updateDrawingContext()
@@ -1184,8 +1178,7 @@ GHOST_TSuccess GHOST_WindowCocoa::removeDrawingContext()
        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
        switch (m_drawingContextType) {
                case GHOST_kDrawingContextTypeOpenGL:
-                       if (m_openGLContext)
-                       {
+                       if (m_openGLContext) {
                                [m_openGLView clearGLContext];
                                if (s_firstOpenGLcontext == m_openGLContext) s_firstOpenGLcontext = nil;
                                m_openGLContext = nil;
@@ -1222,24 +1215,24 @@ GHOST_TSuccess GHOST_WindowCocoa::setProgressBar(float progress)
                NSImage* dockIcon = [[NSImage alloc] initWithSize:NSMakeSize(128,128)];
                
                [dockIcon lockFocus];
-        NSRect progressBox = {{4, 4}, {120, 16}};
-
-        [[NSImage imageNamed:@"NSApplicationIcon"] dissolveToPoint:NSZeroPoint fraction:1.0];
-        
-        // Track & Outline
-        [[NSColor blackColor] setFill];
-        NSRectFill(progressBox);
-        
-        [[NSColor whiteColor] set];
-        NSFrameRect(progressBox);
-        
-        // Progress fill
-        progressBox = NSInsetRect(progressBox, 1, 1);
-        
-        progressBox.size.width = progressBox.size.width * progress;
-        NSGradient *gradient = [[NSGradient alloc] initWithStartingColor:[NSColor darkGrayColor] endingColor:[NSColor lightGrayColor]];
-        [gradient drawInRect:progressBox angle:90];
-        [gradient release];
+               NSRect progressBox = {{4, 4}, {120, 16}};
+
+               [[NSImage imageNamed:@"NSApplicationIcon"] dissolveToPoint:NSZeroPoint fraction:1.0];
+
+               // Track & Outline
+               [[NSColor blackColor] setFill];
+               NSRectFill(progressBox);
+
+               [[NSColor whiteColor] set];
+               NSFrameRect(progressBox);
+
+               // Progress fill
+               progressBox = NSInsetRect(progressBox, 1, 1);
+
+               progressBox.size.width = progressBox.size.width * progress;
+               NSGradient *gradient = [[NSGradient alloc] initWithStartingColor:[NSColor darkGrayColor] endingColor:[NSColor lightGrayColor]];
+               [gradient drawInRect:progressBox angle:90];
+               [gradient release];
                
                [dockIcon unlockFocus];
                
@@ -1364,10 +1357,9 @@ GHOST_TSuccess GHOST_WindowCocoa::setWindowCursorGrab(GHOST_TGrabCursorMode mode
 {
        GHOST_TSuccess err = GHOST_kSuccess;
        
-       if (mode != GHOST_kGrabDisable)
-       {
+       if (mode != GHOST_kGrabDisable) {
                //No need to perform grab without warp as it is always on in OS X
-               if(mode != GHOST_kGrabNormal) {
+               if (mode != GHOST_kGrabNormal) {
                        GHOST_TInt32 x_old,y_old;
                        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
 
@@ -1376,7 +1368,7 @@ GHOST_TSuccess GHOST_WindowCocoa::setWindowCursorGrab(GHOST_TGrabCursorMode mode
                        //Warp position is stored in client (window base) coordinates
                        setCursorGrabAccum(0, 0);
                        
-                       if(mode == GHOST_kGrabHide) {
+                       if (mode == GHOST_kGrabHide) {
                                setWindowCursorVisibility(false);
                        }
                        
@@ -1390,8 +1382,7 @@ GHOST_TSuccess GHOST_WindowCocoa::setWindowCursorGrab(GHOST_TGrabCursorMode mode
                }
        }
        else {
-               if(m_cursorGrab==GHOST_kGrabHide)
-               {
+               if (m_cursorGrab==GHOST_kGrabHide) {
                        //No need to set again cursor position, as it has not changed for Cocoa
                        setWindowCursorVisibility(true);
                }
index 2b7fb66..1816c57 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 11, 2001
+ * \author     Maarten Gribnau
+ * \date       May 11, 2001
  */
 
 #include "GHOST_WindowManager.h"
index e754595..ecf0cb3 100644 (file)
@@ -41,8 +41,8 @@
 
 /**
  * Manages system windows (platform independent implementation).
- * @author     Maarten Gribnau
- * @date       May 11, 2001
+ * \author     Maarten Gribnau
+ * \date       May 11, 2001
  */
 class GHOST_WindowManager
 {
@@ -60,68 +60,68 @@ public:
        /**
         * Add a window to our list.
         * It is only added if it is not already in the list.
-        * @param       window Pointer to the window to be added.
-        * @return      Indication of success.
+        * \param       window Pointer to the window to be added.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess addWindow(GHOST_IWindow *window);
 
        /**
         * Remove a window from our list.
-        * @param       window Pointer to the window to be removed.
-        * @return      Indication of success.
+        * \param       window Pointer to the window to be removed.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess removeWindow(const GHOST_IWindow *window);
 
        /**
         * Returns whether the window is in our list.
-        * @param       window Pointer to the window to query.
-        * @return      A boolean indicator.
+        * \param       window Pointer to the window to query.
+        * \return      A boolean indicator.
         */
        virtual bool getWindowFound(const GHOST_IWindow *window) const;
 
        /**
         * Returns whether one of the windows is fullscreen.
-        * @return      A boolean indicator.
+        * \return      A boolean indicator.
         */
        virtual bool getFullScreen(void) const;
 
        /**
         * Returns pointer to the full-screen window.
-        * @return      The fll-screen window (0 if not in full-screen).
+        * \return      The fll-screen window (0 if not in full-screen).
         */
        virtual GHOST_IWindow *getFullScreenWindow(void) const;
 
        /**
         * Activates fullscreen mode for a window.
-        * @param window The window displayed fullscreen.
-        * @return      Indication of success.
+        * \param window The window displayed fullscreen.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess beginFullScreen(GHOST_IWindow *window, const bool stereoVisual);
 
        /**
         * Closes fullscreen mode down.
-        * @return      Indication of success.
+        * \return      Indication of success.
         */
        virtual GHOST_TSuccess endFullScreen(void);
 
        /**
         * Sets new window as active window (the window receiving events).
         * There can be only one window active which should be in the current window list.
-        * @param window The new active window.
+        * \param window The new active window.
         */
        virtual GHOST_TSuccess setActiveWindow(GHOST_IWindow *window);
        
        /**
         * Returns the active window (the window receiving events).
         * There can be only one window active which should be in the current window list.
-        * @return window The active window (or NULL if there is none).
+        * \return window The active window (or NULL if there is none).
         */
        virtual GHOST_IWindow *getActiveWindow(void) const;
        
 
        /**
         * Set this window to be inactive (not receiving events).
-        * @param window The window to decativate.
+        * \param window The window to decativate.
         */
        virtual void setWindowInactive(const GHOST_IWindow *window);
        
@@ -129,7 +129,7 @@ public:
        /**
         * Return a vector of the windows currently managed by this 
         * class. 
-        * @warning It is very dangerous to mess with the contents of 
+        * \warning It is very dangerous to mess with the contents of
         * this vector. Please do not destroy or add windows use the 
         * interface above for this,
         */
@@ -137,14 +137,14 @@ public:
        
        /**
         * Finds the window associated with an OS window object/handle
-        * @param osWindow The OS window object/handle
-        * @return The associated window, null if none corresponds
+        * \param osWindow The OS window object/handle
+        * \return The associated window, null if none corresponds
         */
        virtual GHOST_IWindow *getWindowAssociatedWithOSWindow(void *osWindow);
        
        /**
         * Return true if any windows has a modified status
-        * @return True if any window has unsaved changes
+        * \return True if any window has unsaved changes
         */
        bool getAnyModifiedState();
 
index 71a9db3..0e8ff43 100644 (file)
@@ -32,8 +32,8 @@
 
 /**
  * Copyright (C) 2001 NaN Technologies B.V.
- * @author     Maarten Gribnau
- * @date       May 10, 2001
+ * \author     Maarten Gribnau
+ * \date       May 10, 2001
  */
 
 #include <string.h>
index cf5a7fe..3f52f9e 100644 (file)
@@ -61,8 +61,8 @@ typedef BOOL (API * GHOST_WIN32_WTPacket)(HCTX, UINT, LPVOID);
 
 /**
  * GHOST window on M$ Windows OSs.
- * @author     Maarten Gribnau
- * @date       May 10, 2001
+ * \author     Maarten Gribnau
+ * \date       May 10, 2001
  */
 class GHOST_WindowWin32 : public GHOST_Window {
 public:
@@ -70,15 +70,15 @@ public:
         * Constructor.
         * Creates a new window and opens it.
         * To check if the window was created properly, use the getValid() method.
-        * @param title         The text shown in the title bar of the window.
-        * @param left          The coordinate of the left edge of the window.
-        * @param top           The coordinate of the top edge of the window.
-        * @param width         The width the window.
-        * @param height        The height the window.
-        * @param state         The state the window is initially opened with.
-        * @param type          The type of drawing context installed in this window.
-        * @param stereoVisual  Stereo visual for quad buffered stereo.
-        * @param numOfAASamples        Number of samples used for AA (zero if no AA)
+        * \param title         The text shown in the title bar of the window.
+        * \param left          The coordinate of the left edge of the window.
+        * \param top           The coordinate of the top edge of the window.
+        * \param width         The width the window.
+        * \param height        The height the window.
+        * \param state         The state the window is initially opened with.
+        * \param type          The type of drawing context installed in this window.
+        * \param stereoVisual  Stereo visual for quad buffered stereo.
+        * \param numOfAASamples        Number of samples used for AA (zero if no AA)
         */
        GHOST_WindowWin32(
            GHOST_SystemWin32 *system,
@@ -104,115 +104,115 @@ public:
 
        /**
         * Returns the window to replace this one if it's getting replaced
-        * @return The window replacing this one.
+        * \return The window replacing this one.
         */
 
        GHOST_Window *getNextWindow();
 
        /**
         * Returns indication as to whether the window is valid.
-        * @return The validity of the window.
+        * \return The validity of the window.
         */
        virtual bool getValid() const;
 
        /**
         * Access to the handle of the window.
-        * @return The handle of the window.
+        * \return The handle of the window.
         */
        virtual HWND getHWND() const;
 
        /**
         * Sets the title displayed in the title bar.
-        * @param title The title to display in the title bar.
+        * \param title The title to display in the title bar.
         */
        virtual void setTitle(const STR_String& title);
 
        /**
         * Returns the title displayed in the title bar.
-        * @param title The title displayed in the title bar.
+        * \param title The title displayed in the title bar.
         */
        virtual void getTitle(STR_String& title) const;
 
        /**
         * Returns the window rectangle dimensions.
         * The dimensions are given in screen coordinates that are relative to the upper-left corner of the screen. 
-        * @param bounds The bounding rectangle of the window.
+        * \param bounds The bounding rectangle of the window.
         */
        virtual void getWindowBounds(GHOST_Rect& bounds) const;
        
        /**
         * Returns the client rectangle dimensions.
         * The left and top members of the rectangle are always zero.
-        * @param bounds The bounding rectangle of the cleient area of the window.
+        * \param bounds The bounding rectangle of the cleient area of the window.
         */
        virtual void getClientBounds(GHOST_Rect& bounds) const;
 
        /**
         * Resizes client rectangle width.
-        * @param width The new width of the client area of the window.
+        * \param width The new width of the client area of the window.
         */
        virtual GHOST_TSuccess setClientWidth(GHOST_TUns32 width);
 
        /**
         * Resizes client rectangle height.
-        * @param height The new height of the client area of the window.
+        * \param height The new height of the client area of the window.
         */
        virtual GHOST_TSuccess setClientHeight(GHOST_TUns32 height);
 
        /**
         * Resizes client rectangle.
-        * @param width         The new width of the client area of the window.
-        * @param height        The new height of the client area of the window.
+        * \param width         The new width of the client area of the window.
+        * \param height        The new height of the client area of the window.
         */
        virtual GHOST_TSuccess setClientSize(GHOST_TUns32 width, GHOST_TUns32 height);
 
        /**
         * Returns the state of the window (normal, minimized, maximized).
-        * @return The state of the window.
+        * \return The state of the window.
         */
        virtual GHOST_TWindowState getState() const;
 
        /**
         * Converts a point in screen coordinates to client rectangle coordinates
-        * @param inX   The x-coordinate on the screen.
-        * @param inY   The y-coordinate on the screen.
-        * @param outX  The x-coordinate in the client rectangle.
-        * @param outY  The y-coordinate in the client rectangle.
+        * \param inX   The x-coordinate on the screen.
+        * \param inY   The y-coordinate on the screen.
+        * \param outX  The x-coordinate in the client rectangle.
+        * \param outY  The y-coordinate in the client rectangle.
         */
        virtual void screenToClient(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 
        /**
         * Converts a point in screen coordinates to client rectangle coordinates
-        * @param inX   The x-coordinate in the client rectangle.
-        * @param inY   The y-coordinate in the client rectangle.
-        * @param outX  The x-coordinate on the screen.
-        * @param outY  The y-coordinate on the screen.
+        * \param inX   The x-coordinate in the client rectangle.
+        * \param inY   The y-coordinate in the client rectangle.
+        * \param outX  The x-coordinate on the screen.
+        * \param outY  The y-coordinate on the screen.
         */
        virtual void clientToScreen(GHOST_TInt32 inX, GHOST_TInt32 inY, GHOST_TInt32& outX, GHOST_TInt32& outY) const;
 
        /**
         * Sets the state of the window (normal, minimized, maximized).
-        * @param state The state of the window.
-        * @return Indication of success.
+        * \param state The state of the window.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setState(GHOST_TWindowState state);
 
        /**
         * Sets the order of the window (bottom, top).
-        * @param order The order of the window.
-        * @return Indication of success.
+        * \param order The order of the window.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess setOrder(GHOST_TWindowOrder order);
 
        /**
         * Swaps front and back buffers of a window.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess swapBuffers();
 
        /**
         * Activates the drawing context of this window.
-        * @return Indication of success.
+        * \return Indication of success.
         */
        virtual GHOST_TSuccess activateDrawingContext();
 
@@ -223,7 +223,7 @@ public:
 
        /**
         * Sets the progress bar value displayed in the window/application icon
-        * @param progress The progress %
+        * \param progress The progress %
         */
        virtual GHOST_TSuccess setProgressBar(float progress);
        
@@ -234,7 +234,7 @@ public:
        
        /**
         * Returns the name of the window class.
-        * @return The name of the window class.
+        * \return The name of the window class.
         */
        static wchar_t *getWindowClassName() {
                return s_windowClassName;
@@ -245,7 +245,7 @@ public:
         * for any real button press, controls mou