code clenup: comments and some style edits on ghost/osx (odd indentation)

1 files changed, 67 insertions, 66 deletions

diff --git a/intern/ghost/GHOST_ISystem.h b/intern/ghost/GHOST_ISystem.h
index 474e3e97c45..8aef81bb762 100644
--- a/intern/ghost/GHOST_ISystem.h
+++ b/intern/ghost/GHOST_ISystem.h
@@ -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;