[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [50443] trunk/blender: code clenup: comments and some style edits on ghost/osx (odd indentation)
Campbell Barton
ideasman42 at gmail.com
Thu Sep 6 04:10:13 CEST 2012
Revision: 50443
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=50443
Author: campbellbarton
Date: 2012-09-06 02:10:09 +0000 (Thu, 06 Sep 2012)
Log Message:
-----------
code clenup: comments and some style edits on ghost/osx (odd indentation)
Modified Paths:
--------------
trunk/blender/intern/audaspace/intern/AUD_ReferenceHandler.cpp
trunk/blender/intern/ghost/GHOST_IEvent.h
trunk/blender/intern/ghost/GHOST_IEventConsumer.h
trunk/blender/intern/ghost/GHOST_ISystem.h
trunk/blender/intern/ghost/GHOST_ISystemPaths.h
trunk/blender/intern/ghost/GHOST_ITimerTask.h
trunk/blender/intern/ghost/GHOST_IWindow.h
trunk/blender/intern/ghost/GHOST_Path-api.h
trunk/blender/intern/ghost/GHOST_Rect.h
trunk/blender/intern/ghost/GHOST_Types.h
trunk/blender/intern/ghost/intern/GHOST_Buttons.h
trunk/blender/intern/ghost/intern/GHOST_CallbackEventConsumer.cpp
trunk/blender/intern/ghost/intern/GHOST_CallbackEventConsumer.h
trunk/blender/intern/ghost/intern/GHOST_DisplayManager.cpp
trunk/blender/intern/ghost/intern/GHOST_DisplayManager.h
trunk/blender/intern/ghost/intern/GHOST_DisplayManagerCarbon.cpp
trunk/blender/intern/ghost/intern/GHOST_DisplayManagerCarbon.h
trunk/blender/intern/ghost/intern/GHOST_DisplayManagerCocoa.h
trunk/blender/intern/ghost/intern/GHOST_DisplayManagerWin32.h
trunk/blender/intern/ghost/intern/GHOST_DisplayManagerX11.h
trunk/blender/intern/ghost/intern/GHOST_DropTargetWin32.h
trunk/blender/intern/ghost/intern/GHOST_DropTargetX11.h
trunk/blender/intern/ghost/intern/GHOST_Event.h
trunk/blender/intern/ghost/intern/GHOST_EventButton.h
trunk/blender/intern/ghost/intern/GHOST_EventCursor.h
trunk/blender/intern/ghost/intern/GHOST_EventDragnDrop.h
trunk/blender/intern/ghost/intern/GHOST_EventKey.h
trunk/blender/intern/ghost/intern/GHOST_EventManager.cpp
trunk/blender/intern/ghost/intern/GHOST_EventManager.h
trunk/blender/intern/ghost/intern/GHOST_EventPrinter.h
trunk/blender/intern/ghost/intern/GHOST_EventString.h
trunk/blender/intern/ghost/intern/GHOST_EventTrackpad.h
trunk/blender/intern/ghost/intern/GHOST_EventWheel.h
trunk/blender/intern/ghost/intern/GHOST_ISystem.cpp
trunk/blender/intern/ghost/intern/GHOST_ISystemPaths.cpp
trunk/blender/intern/ghost/intern/GHOST_ModifierKeys.cpp
trunk/blender/intern/ghost/intern/GHOST_ModifierKeys.h
trunk/blender/intern/ghost/intern/GHOST_System.h
trunk/blender/intern/ghost/intern/GHOST_SystemCarbon.cpp
trunk/blender/intern/ghost/intern/GHOST_SystemCarbon.h
trunk/blender/intern/ghost/intern/GHOST_SystemCocoa.h
trunk/blender/intern/ghost/intern/GHOST_SystemCocoa.mm
trunk/blender/intern/ghost/intern/GHOST_SystemPaths.h
trunk/blender/intern/ghost/intern/GHOST_SystemPathsCarbon.h
trunk/blender/intern/ghost/intern/GHOST_SystemPathsCocoa.h
trunk/blender/intern/ghost/intern/GHOST_SystemPathsWin32.h
trunk/blender/intern/ghost/intern/GHOST_SystemPathsX11.h
trunk/blender/intern/ghost/intern/GHOST_SystemWin32.h
trunk/blender/intern/ghost/intern/GHOST_SystemX11.cpp
trunk/blender/intern/ghost/intern/GHOST_SystemX11.h
trunk/blender/intern/ghost/intern/GHOST_TimerManager.cpp
trunk/blender/intern/ghost/intern/GHOST_TimerManager.h
trunk/blender/intern/ghost/intern/GHOST_TimerTask.h
trunk/blender/intern/ghost/intern/GHOST_Window.cpp
trunk/blender/intern/ghost/intern/GHOST_Window.h
trunk/blender/intern/ghost/intern/GHOST_WindowCarbon.cpp
trunk/blender/intern/ghost/intern/GHOST_WindowCarbon.h
trunk/blender/intern/ghost/intern/GHOST_WindowCocoa.h
trunk/blender/intern/ghost/intern/GHOST_WindowCocoa.mm
trunk/blender/intern/ghost/intern/GHOST_WindowManager.cpp
trunk/blender/intern/ghost/intern/GHOST_WindowManager.h
trunk/blender/intern/ghost/intern/GHOST_WindowWin32.cpp
trunk/blender/intern/ghost/intern/GHOST_WindowWin32.h
trunk/blender/intern/ghost/intern/GHOST_WindowX11.cpp
trunk/blender/intern/ghost/intern/GHOST_WindowX11.h
trunk/blender/intern/ghost/test/gears/GHOST_C-Test.c
trunk/blender/intern/ghost/test/gears/GHOST_Test.cpp
trunk/blender/source/blender/blenkernel/BKE_object_deform.h
trunk/blender/source/blender/bmesh/bmesh.h
trunk/blender/source/blender/bmesh/intern/bmesh_core.c
trunk/blender/source/blender/bmesh/operators/bmo_subdivide.c
trunk/blender/source/blender/compositor/COM_compositor.h
trunk/blender/source/blender/compositor/intern/COM_ExecutionSystemHelper.h
trunk/blender/source/blender/compositor/operations/COM_RenderLayersImageProg.h
trunk/blender/source/blender/editors/io/io_collada.h
trunk/blender/source/blender/editors/io/io_ops.h
trunk/blender/source/blender/imbuf/intern/imbuf_cocoa.m
trunk/blender/source/gameengine/Ketsji/KX_PythonMain.cpp
Modified: trunk/blender/intern/audaspace/intern/AUD_ReferenceHandler.cpp
===================================================================
--- trunk/blender/intern/audaspace/intern/AUD_ReferenceHandler.cpp 2012-09-06 01:31:15 UTC (rev 50442)
+++ trunk/blender/intern/audaspace/intern/AUD_ReferenceHandler.cpp 2012-09-06 02:10:09 UTC (rev 50443)
@@ -22,7 +22,7 @@
* ***** END GPL LICENSE BLOCK *****
*/
-/** \file audaspace/intern/AUD_Reference.cpp
+/** \file audaspace/intern/AUD_ReferenceHandler.cpp
* \ingroup audaspaceintern
*/
Modified: trunk/blender/intern/ghost/GHOST_IEvent.h
===================================================================
--- trunk/blender/intern/ghost/GHOST_IEvent.h 2012-09-06 01:31:15 UTC (rev 50442)
+++ trunk/blender/intern/ghost/GHOST_IEvent.h 2012-09-06 02:10:09 UTC (rev 50443)
@@ -45,10 +45,10 @@
* 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 @@
/**
* 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;
Modified: trunk/blender/intern/ghost/GHOST_IEventConsumer.h
===================================================================
--- trunk/blender/intern/ghost/GHOST_IEventConsumer.h 2012-09-06 01:31:15 UTC (rev 50442)
+++ trunk/blender/intern/ghost/GHOST_IEventConsumer.h 2012-09-06 02:10:09 UTC (rev 50443)
@@ -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 @@
/**
* 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;
Modified: trunk/blender/intern/ghost/GHOST_ISystem.h
===================================================================
--- trunk/blender/intern/ghost/GHOST_ISystem.h 2012-09-06 01:31:15 UTC (rev 50442)
+++ trunk/blender/intern/ghost/GHOST_ISystem.h 2012-09-06 02:10:09 UTC (rev 50443)
@@ -136,27 +136,27 @@
* -# 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 @@
* 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 @@
* 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 @@
/**
* 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 @@
/**
* 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 @@
* 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 @@
/**
* 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 @@
/**
* 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.
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list