[Bf-blender-cvs] [d9046cc] master: Cleanup: doxygen comments
Campbell Barton
noreply at git.blender.org
Wed Jul 1 08:35:59 CEST 2015
Commit: d9046ccbd4cfc26375d852ef2ccd6edb4d6d0e6a
Author: Campbell Barton
Date: Wed Jul 1 16:30:26 2015 +1000
Branches: master
https://developer.blender.org/rBd9046ccbd4cfc26375d852ef2ccd6edb4d6d0e6a
Cleanup: doxygen comments
===================================================================
M intern/ghost/GHOST_C-api.h
M intern/ghost/GHOST_ISystem.h
M intern/ghost/GHOST_ITimerTask.h
M intern/ghost/GHOST_IWindow.h
M intern/ghost/intern/GHOST_DisplayManagerCocoa.h
M intern/ghost/intern/GHOST_DisplayManagerWin32.h
M intern/ghost/intern/GHOST_DisplayManagerX11.h
M intern/ghost/intern/GHOST_EventButton.h
M intern/ghost/intern/GHOST_EventTrackpad.h
M intern/ghost/intern/GHOST_EventWheel.h
M intern/ghost/intern/GHOST_ModifierKeys.h
M intern/ghost/intern/GHOST_SystemCocoa.h
M intern/ghost/intern/GHOST_SystemWin32.h
M intern/ghost/intern/GHOST_SystemX11.cpp
M intern/ghost/intern/GHOST_TimerTask.h
M intern/ghost/intern/GHOST_Window.h
M intern/ghost/intern/GHOST_WindowX11.h
===================================================================
diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h
index 7715979..ff0dc57 100644
--- a/intern/ghost/GHOST_C-api.h
+++ b/intern/ghost/GHOST_C-api.h
@@ -40,7 +40,7 @@ extern "C" {
#endif
/**
- * Creates a "handle" for a C++ GHOST object.
+ * Creates a "handle" for a C++ GHOST object.
* A handle is just an opaque pointer to an empty struct.
* In the API the pointer is casted to the actual C++ class.
* \param name Name of the handle to create.
@@ -174,19 +174,19 @@ extern void GHOST_GetAllDisplayDimensions(GHOST_SystemHandle systemhandle,
* \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 glSettings: Misc OpenGL options.
* \return A handle to the new window ( == NULL if creation failed).
*/
-extern GHOST_WindowHandle GHOST_CreateWindow(GHOST_SystemHandle systemhandle,
- const char *title,
- GHOST_TInt32 left,
- GHOST_TInt32 top,
- GHOST_TUns32 width,
- GHOST_TUns32 height,
- GHOST_TWindowState state,
- GHOST_TDrawingContextType type,
- GHOST_GLSettings glSettings);
+extern GHOST_WindowHandle GHOST_CreateWindow(
+ GHOST_SystemHandle systemhandle,
+ const char *title,
+ GHOST_TInt32 left,
+ GHOST_TInt32 top,
+ GHOST_TUns32 width,
+ GHOST_TUns32 height,
+ GHOST_TWindowState state,
+ GHOST_TDrawingContextType type,
+ GHOST_GLSettings glSettings);
/**
* Returns the window user data.
diff --git a/intern/ghost/GHOST_ISystem.h b/intern/ghost/GHOST_ISystem.h
index 33540f3..6825e8a 100644
--- a/intern/ghost/GHOST_ISystem.h
+++ b/intern/ghost/GHOST_ISystem.h
@@ -241,8 +241,8 @@ public:
* \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 glSettings: Misc OpenGL settings.
+ * \param exclusive: Use to show the window ontop and ignore others (used fullscreen).
* \param parentWindow Parent (embedder) window
* \return The new window (or 0 if creation failed).
*/
diff --git a/intern/ghost/GHOST_ITimerTask.h b/intern/ghost/GHOST_ITimerTask.h
index fcd42db..9bea697 100644
--- a/intern/ghost/GHOST_ITimerTask.h
+++ b/intern/ghost/GHOST_ITimerTask.h
@@ -80,7 +80,7 @@ public:
/**
* Changes the time user data.
- * \param data The timer user data.
+ * \param userData: The timer user data.
*/
virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
diff --git a/intern/ghost/GHOST_IWindow.h b/intern/ghost/GHOST_IWindow.h
index 649f067..688ebec 100644
--- a/intern/ghost/GHOST_IWindow.h
+++ b/intern/ghost/GHOST_IWindow.h
@@ -212,7 +212,6 @@ public:
/**
* Gets the current swap interval for swapBuffers.
- * \param windowhandle The handle to the window
* \param intervalOut pointer to location to return swap interval (left untouched if there is an error)
* \return A boolean success indicator of if swap interval was successfully read.
*/
@@ -244,7 +243,7 @@ public:
/**
* Changes the window user data.
- * \param data The window user data.
+ * \param userData The window user data.
*/
virtual void setUserData(const GHOST_TUserDataPtr userData) = 0;
@@ -281,8 +280,8 @@ public:
/**
* Set the shape of the cursor.
- * \param cursor The new cursor shape type id.
- * \return Indication of success.
+ * \param cursorShape: The new cursor shape type id.
+ * \return Indication of success.
*/
virtual GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape) = 0;
diff --git a/intern/ghost/intern/GHOST_DisplayManagerCocoa.h b/intern/ghost/intern/GHOST_DisplayManagerCocoa.h
index bfed2e0..f580820 100644
--- a/intern/ghost/intern/GHOST_DisplayManagerCocoa.h
+++ b/intern/ghost/intern/GHOST_DisplayManagerCocoa.h
@@ -63,7 +63,7 @@ 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.
+ * \param numSetting: The number of settings of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
diff --git a/intern/ghost/intern/GHOST_DisplayManagerWin32.h b/intern/ghost/intern/GHOST_DisplayManagerWin32.h
index 801ad29..ff8849f 100644
--- a/intern/ghost/intern/GHOST_DisplayManagerWin32.h
+++ b/intern/ghost/intern/GHOST_DisplayManagerWin32.h
@@ -63,7 +63,7 @@ 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.
+ * \param numSetting: The number of settings of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess getNumDisplaySettings(GHOST_TUns8 display, GHOST_TInt32& numSettings) const;
diff --git a/intern/ghost/intern/GHOST_DisplayManagerX11.h b/intern/ghost/intern/GHOST_DisplayManagerX11.h
index 66fd1e5..b54c53c 100644
--- a/intern/ghost/intern/GHOST_DisplayManagerX11.h
+++ b/intern/ghost/intern/GHOST_DisplayManagerX11.h
@@ -66,7 +66,7 @@ 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.
+ * \param numSetting: The number of settings of the display device with this index.
* \return Indication of success.
*/
GHOST_TSuccess
diff --git a/intern/ghost/intern/GHOST_EventButton.h b/intern/ghost/intern/GHOST_EventButton.h
index f88fe6e..ef5c5ef 100644
--- a/intern/ghost/intern/GHOST_EventButton.h
+++ b/intern/ghost/intern/GHOST_EventButton.h
@@ -47,9 +47,8 @@ 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 window: The window of this event.
+ * \param button: The state of the buttons were 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)
diff --git a/intern/ghost/intern/GHOST_EventTrackpad.h b/intern/ghost/intern/GHOST_EventTrackpad.h
index dc8b164..b4e80b5 100644
--- a/intern/ghost/intern/GHOST_EventTrackpad.h
+++ b/intern/ghost/intern/GHOST_EventTrackpad.h
@@ -45,7 +45,7 @@ public:
/**
* Constructor.
* \param msec The time this event was generated.
- * \param type The type of this event.
+ * \param window: The window 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.
diff --git a/intern/ghost/intern/GHOST_EventWheel.h b/intern/ghost/intern/GHOST_EventWheel.h
index 216f13f..a632492 100644
--- a/intern/ghost/intern/GHOST_EventWheel.h
+++ b/intern/ghost/intern/GHOST_EventWheel.h
@@ -47,9 +47,9 @@ 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 window: The window 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)
diff --git a/intern/ghost/intern/GHOST_ModifierKeys.h b/intern/ghost/intern/GHOST_ModifierKeys.h
index 75173f5..a30b66c 100644
--- a/intern/ghost/intern/GHOST_ModifierKeys.h
+++ b/intern/ghost/intern/GHOST_ModifierKeys.h
@@ -59,15 +59,15 @@ struct GHOST_ModifierKeys {
/**
* Returns the state of a single modifier key.
- * \param mask. Key state to return.
+ * \param mask: Key state to return.
* \return The state of the key (pressed == true).
*/
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.
*/
void set(GHOST_TModifierKeyMask mask, bool down);
@@ -78,7 +78,7 @@ struct GHOST_ModifierKeys {
/**
* Determines whether to modifier key states are equal.
- * \param keys. The modifier key state to compare to.
+ * \param keys: The modifier key state to compare to.
* \return Indication of equality.
*/
bool equals(const GHOST_ModifierKeys& keys) const;
diff --git a/intern/ghost/intern/GHOST_SystemCocoa.h b/intern/ghost/intern/GHOST_SystemCocoa.h
index a86575a..3d6b40e 100644
--- a/intern/ghost/intern/GHOST_SystemCocoa.h
+++ b/intern/ghost/intern/GHOST_SystemCocoa.h
@@ -105,8 +105,8 @@ public:
* \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
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list