diff options
author | Campbell Barton <ideasman42@gmail.com> | 2015-07-01 09:30:26 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2015-07-01 09:30:26 +0300 |
commit | d9046ccbd4cfc26375d852ef2ccd6edb4d6d0e6a (patch) | |
tree | 07a5dbabc00216f7c1af0b5535e4b2c80426d3a6 /intern/ghost | |
parent | 1779452eb455434ae151fa150e028060ddcf1c26 (diff) |
Cleanup: doxygen comments
Diffstat (limited to 'intern/ghost')
-rw-r--r-- | intern/ghost/GHOST_C-api.h | 24 | ||||
-rw-r--r-- | intern/ghost/GHOST_ISystem.h | 4 | ||||
-rw-r--r-- | intern/ghost/GHOST_ITimerTask.h | 2 | ||||
-rw-r--r-- | intern/ghost/GHOST_IWindow.h | 7 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_DisplayManagerCocoa.h | 2 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_DisplayManagerWin32.h | 2 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_DisplayManagerX11.h | 2 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_EventButton.h | 5 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_EventTrackpad.h | 2 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_EventWheel.h | 6 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_ModifierKeys.h | 8 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_SystemCocoa.h | 4 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_SystemWin32.h | 6 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_SystemX11.cpp | 6 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_TimerTask.h | 6 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_Window.h | 4 | ||||
-rw-r--r-- | intern/ghost/intern/GHOST_WindowX11.h | 1 |
17 files changed, 43 insertions, 48 deletions
diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h index 7715979d8bf..ff0dc575005 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 33540f3069d..6825e8a0384 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 fcd42db59da..9bea697cbc8 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 649f06749b6..688ebecf557 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 bfed2e0d37e..f580820d8f6 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 801ad29f45a..ff8849f03c9 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 66fd1e5c15e..b54c53c67bd 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 f88fe6e201d..ef5c5efa202 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 dc8b1649754..b4e80b5fd06 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 216f13fda4e..a632492acb9 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 75173f5a525..a30b66c4634 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 a86575abade..3d6b40ee541 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 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/intern/GHOST_SystemWin32.h b/intern/ghost/intern/GHOST_SystemWin32.h index 3841ae58b8d..0a8837294db 100644 --- a/intern/ghost/intern/GHOST_SystemWin32.h +++ b/intern/ghost/intern/GHOST_SystemWin32.h @@ -118,8 +118,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 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). */ @@ -283,7 +283,7 @@ protected: * Process special keys (VK_OEM_*), to see if current key layout * gives us anything special, like ! on french AZERTY. * \param vKey The virtual key from hardKey - * \param ScanCode The ScanCode of pressed key (simular to PS/2 Set 1) + * \param scanCode The ScanCode of pressed key (simular to PS/2 Set 1) */ GHOST_TKey processSpecialKey(short vKey, short scanCode) const; diff --git a/intern/ghost/intern/GHOST_SystemX11.cpp b/intern/ghost/intern/GHOST_SystemX11.cpp index 7a4fb254ce7..45237391eff 100644 --- a/intern/ghost/intern/GHOST_SystemX11.cpp +++ b/intern/ghost/intern/GHOST_SystemX11.cpp @@ -280,10 +280,8 @@ getAllDisplayDimensions( * \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 exclusive Use to show the window ontop and ignore others - * (used fullscreen). - * \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/intern/GHOST_TimerTask.h b/intern/ghost/intern/GHOST_TimerTask.h index 201ed144712..45aa66e4630 100644 --- a/intern/ghost/intern/GHOST_TimerTask.h +++ b/intern/ghost/intern/GHOST_TimerTask.h @@ -49,7 +49,7 @@ public: * \param start The timer start time. * \param interval The interval between calls to the timerProc * \param timerProc The callback invoked when the interval expires. - * \param data The timer user data. + * \param userData: The timer user data. */ GHOST_TimerTask(GHOST_TUns64 start, GHOST_TUns64 interval, @@ -129,7 +129,7 @@ public: /** * Changes the timer callback. - * \param The timer callback. + * \param timerProc: The timer callback. */ inline void setTimerProc(const GHOST_TimerProcPtr timerProc) { @@ -147,7 +147,7 @@ public: /** * Changes the time user data. - * \param data The timer user data. + * \param userData: The timer user data. */ void setUserData(const GHOST_TUserDataPtr userData) { diff --git a/intern/ghost/intern/GHOST_Window.h b/intern/ghost/intern/GHOST_Window.h index d894a30bf25..52cb9cbf54b 100644 --- a/intern/ghost/intern/GHOST_Window.h +++ b/intern/ghost/intern/GHOST_Window.h @@ -123,7 +123,7 @@ public: /** * Set the shape of the cursor. - * \param cursor The new cursor shape type id. + * \param cursorShape: The new cursor shape type id. * \return Indication of success. */ GHOST_TSuccess setCursorShape(GHOST_TStandardCursor cursorShape); @@ -281,7 +281,7 @@ public: /** * Changes the window user data. - * \param data The window user data. + * \param userData: The window user data. */ void setUserData(const GHOST_TUserDataPtr userData) { diff --git a/intern/ghost/intern/GHOST_WindowX11.h b/intern/ghost/intern/GHOST_WindowX11.h index 277afe38e19..77287c1befc 100644 --- a/intern/ghost/intern/GHOST_WindowX11.h +++ b/intern/ghost/intern/GHOST_WindowX11.h @@ -247,7 +247,6 @@ protected: /** * Sets the cursor grab on the window using * native window system calls. - * \param warp Only used when grab is enabled, hides the mouse and allows dragging outside the screen. */ GHOST_TSuccess setWindowCursorGrab( |