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

1 files changed, 52 insertions, 52 deletions

diff --git a/intern/ghost/intern/GHOST_SystemCocoa.h b/intern/ghost/intern/GHOST_SystemCocoa.h
index cb4e9fe3c99..08f982ffd3f 100644
--- a/intern/ghost/intern/GHOST_SystemCocoa.h
+++ b/intern/ghost/intern/GHOST_SystemCocoa.h
@@ -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);