[Bf-blender-cvs] [5b1fcf88334] master: Cleanup: comments (long lines) in ghost
Campbell Barton
noreply at git.blender.org
Wed May 1 13:45:38 CEST 2019
Commit: 5b1fcf88334620af97f70ceb591eaf0fb153ed03
Author: Campbell Barton
Date: Wed May 1 20:23:13 2019 +1000
Branches: master
https://developer.blender.org/rB5b1fcf88334620af97f70ceb591eaf0fb153ed03
Cleanup: comments (long lines) in ghost
===================================================================
M intern/ghost/GHOST_C-api.h
M intern/ghost/GHOST_ISystem.h
M intern/ghost/GHOST_IWindow.h
M intern/ghost/GHOST_Rect.h
M intern/ghost/GHOST_Types.h
M intern/ghost/intern/GHOST_ContextCGL.mm
M intern/ghost/intern/GHOST_ContextWGL.cpp
M intern/ghost/intern/GHOST_DisplayManagerCocoa.h
M intern/ghost/intern/GHOST_DisplayManagerCocoa.mm
M intern/ghost/intern/GHOST_DropTargetWin32.cpp
M intern/ghost/intern/GHOST_EventDragnDrop.h
M intern/ghost/intern/GHOST_ImeWin32.cpp
M intern/ghost/intern/GHOST_ImeWin32.h
M intern/ghost/intern/GHOST_System.cpp
M intern/ghost/intern/GHOST_SystemCocoa.h
M intern/ghost/intern/GHOST_SystemCocoa.mm
M intern/ghost/intern/GHOST_SystemSDL.cpp
M intern/ghost/intern/GHOST_SystemWin32.cpp
M intern/ghost/intern/GHOST_SystemWin32.h
M intern/ghost/intern/GHOST_SystemX11.cpp
M intern/ghost/intern/GHOST_SystemX11.h
M intern/ghost/intern/GHOST_Window.h
M intern/ghost/intern/GHOST_WindowCocoa.h
M intern/ghost/intern/GHOST_WindowCocoa.mm
M intern/ghost/intern/GHOST_WindowManager.cpp
M intern/ghost/intern/GHOST_WindowSDL.cpp
M intern/ghost/intern/GHOST_WindowWin32.cpp
M intern/ghost/intern/GHOST_WindowWin32.h
M intern/ghost/intern/GHOST_WindowX11.cpp
M intern/ghost/intern/GHOST_WindowX11.h
M intern/ghost/test/gears/GHOST_Test.cpp
===================================================================
diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h
index ec8115c914f..6c490e51b0d 100644
--- a/intern/ghost/GHOST_C-api.h
+++ b/intern/ghost/GHOST_C-api.h
@@ -155,7 +155,8 @@ extern void GHOST_GetAllDisplayDimensions(GHOST_SystemHandle systemhandle,
* The new window is added to the list of windows managed.
* Never explicitly delete the window, use disposeWindow() instead.
* \param systemhandle The handle to the system
- * \param title The name of the window (displayed in the title bar of the window if the OS supports it).
+ * \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.
@@ -684,8 +685,9 @@ extern GHOST_TSuccess GHOST_SetSwapInterval(GHOST_WindowHandle windowhandle, int
/**
* 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)
+ * \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.
*/
extern GHOST_TSuccess GHOST_GetSwapInterval(GHOST_WindowHandle windowhandle, int *intervalOut);
@@ -784,7 +786,8 @@ extern GHOST_TSuccess GHOST_IsEmptyRectangle(GHOST_RectangleHandle rectanglehand
/**
* Returns whether this rectangle is valid.
- * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, empty rectangles are valid.
+ * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b.
+ * Thus, empty rectangles are valid.
* \param rectanglehandle The handle to the rectangle
* \return Success value (true == valid rectangle)
*/
diff --git a/intern/ghost/GHOST_ISystem.h b/intern/ghost/GHOST_ISystem.h
index 0b7b3a18309..3c93d21f30f 100644
--- a/intern/ghost/GHOST_ISystem.h
+++ b/intern/ghost/GHOST_ISystem.h
@@ -226,17 +226,18 @@ class GHOST_ISystem {
* 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 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 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).
+ * \param parentWindow: Parent (embedder) window
+ * \return The new window (or 0 if creation failed).
*/
virtual GHOST_IWindow *createWindow(const STR_String &title,
GHOST_TInt32 left,
diff --git a/intern/ghost/GHOST_IWindow.h b/intern/ghost/GHOST_IWindow.h
index 2c5f6e811d3..6a9e0b9588a 100644
--- a/intern/ghost/GHOST_IWindow.h
+++ b/intern/ghost/GHOST_IWindow.h
@@ -205,7 +205,8 @@ class GHOST_IWindow {
/**
* Gets the current swap interval for swapBuffers.
- * \param intervalOut pointer to location to return swap interval (left untouched if there is an error)
+ * \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.
*/
virtual GHOST_TSuccess getSwapInterval(int &intervalOut) = 0;
diff --git a/intern/ghost/GHOST_Rect.h b/intern/ghost/GHOST_Rect.h
index cd4eb936066..d4c05a7b8aa 100644
--- a/intern/ghost/GHOST_Rect.h
+++ b/intern/ghost/GHOST_Rect.h
@@ -77,23 +77,24 @@ class GHOST_Rect {
/**
* Sets all members of the rectangle.
- * \param l requested left coordinate of the rectangle
- * \param t requested top coordinate of the rectangle
- * \param r requested right coordinate of the rectangle
- * \param b requested bottom coordinate of the rectangle
+ * \param l: requested left coordinate of the rectangle.
+ * \param t: requested top coordinate of the rectangle.
+ * \param r: requested right coordinate of the rectangle.
+ * \param b: requested bottom coordinate of the rectangle.
*/
virtual inline void set(GHOST_TInt32 l, GHOST_TInt32 t, GHOST_TInt32 r, GHOST_TInt32 b);
/**
* Returns whether this rectangle is empty.
* Empty rectangles are rectangles that have width==0 and/or height==0.
- * \return boolean value (true==empty rectangle)
+ * \return boolean value (true==empty rectangle)
*/
virtual inline bool isEmpty() const;
/**
* Returns whether this rectangle is valid.
- * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, empty rectangles are valid.
+ * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b.
+ * Thus, empty rectangles are valid.
* \return boolean value (true==valid rectangle)
*/
virtual inline bool isValid() const;
@@ -101,28 +102,28 @@ class GHOST_Rect {
/**
* Grows (or shrinks the rectangle).
* The method avoids negative insets making the rectangle invalid
- * \param i The amount of offset given to each extreme (negative values shrink the rectangle).
+ * \param i: The amount of offset given to each extreme (negative values shrink the rectangle).
*/
virtual void inset(GHOST_TInt32 i);
/**
* Does a union of the rectangle given and this rectangle.
* The result is stored in this rectangle.
- * \param r The rectangle that is input for the union operation.
+ * \param r: The rectangle that is input for the union operation.
*/
virtual inline void unionRect(const GHOST_Rect &r);
/**
* Grows the rectangle to included a point.
- * \param x The x-coordinate of the point.
- * \param y The y-coordinate of the point.
+ * \param x: The x-coordinate of the point.
+ * \param y: The y-coordinate of the point.
*/
virtual inline void unionPoint(GHOST_TInt32 x, GHOST_TInt32 y);
/**
* Grows the rectangle to included a point.
- * \param x The x-coordinate of the point.
- * \param y The y-coordinate of the point.
+ * \param x The x-coordinate of the point.
+ * \param y The y-coordinate of the point.
*/
virtual inline void wrapPoint(GHOST_TInt32 &x, GHOST_TInt32 &y, GHOST_TInt32 ofs);
diff --git a/intern/ghost/GHOST_Types.h b/intern/ghost/GHOST_Types.h
index 69513ec514c..faba5bb996a 100644
--- a/intern/ghost/GHOST_Types.h
+++ b/intern/ghost/GHOST_Types.h
@@ -367,10 +367,14 @@ typedef enum {
} GHOST_TKey;
typedef enum {
- GHOST_kGrabDisable = 0, /* grab not set */
- GHOST_kGrabNormal, /* no cursor adjustments */
- GHOST_kGrabWrap, /* wrap the mouse location to prevent limiting screen bounds */
- GHOST_kGrabHide, /* hide the mouse while grabbing and restore the original location on release (numbuts) */
+ /** Grab not set. */
+ GHOST_kGrabDisable = 0,
+ /** No cursor adjustments. */
+ GHOST_kGrabNormal,
+ /** Wrap the mouse location to prevent limiting screen bounds. */
+ GHOST_kGrabWrap,
+ /** Hide the mouse while grabbing and restore the original location on release (numbuts). */
+ GHOST_kGrabHide,
} GHOST_TGrabCursorMode;
typedef void *GHOST_TEventDataPtr;
diff --git a/intern/ghost/intern/GHOST_ContextCGL.mm b/intern/ghost/intern/GHOST_ContextCGL.mm
index 4a493cc416d..5b8bb643751 100644
--- a/intern/ghost/intern/GHOST_ContextCGL.mm
+++ b/intern/ghost/intern/GHOST_ContextCGL.mm
@@ -291,7 +291,7 @@ GHOST_TSuccess GHOST_ContextCGL::initializeDrawingContext()
}
#ifdef GHOST_MULTITHREADED_OPENGL
- //Switch openGL to multhreaded mode
+ // Switch openGL to multhreaded mode
if (CGLEnable(CGLGetCurrentContext(), kCGLCEMPEngine) == kCGLNoError)
if (m_debug)
fprintf(stderr, "\nSwitched OpenGL to multithreaded mode\n");
diff --git a/intern/ghost/intern/GHOST_ContextWGL.cpp b/intern/ghost/intern/GHOST_ContextWGL.cpp
index 6918d95445f..d4851450ce8 100644
--- a/intern/ghost/intern/GHOST_ContextWGL.cpp
+++ b/intern/ghost/intern/GHOST_ContextWGL.cpp
@@ -226,11 +226,11 @@ static int choose_pixel_format_legacy(HDC hDC, PIXELFORMATDESCRIPTOR &preferredP
return iPixelFormat;
}
-/*
+/**
* Clone a window for the purpose of creating a temporary context to initialize WGL extensions.
- * There is no generic way to clone the lpParam parameter, so the caller is responsible for cloning it themselves.
+ * There is no generic way to clone the lpParam parameter,
+ * so the caller is responsible for cloning it themselves.
*/
-
static HWND clone_window(HWND hWnd, LPVOID lpParam)
{
int count;
diff --git a/intern/ghost/intern/GHOST_DisplayManagerCocoa.h b/intern/ghost/intern/GHOST_DisplayManagerCocoa.h
index cfdc7be357e..c99e93279f7 100644
--- a/intern/ghost/intern/GHOST_DisplayManagerCocoa.h
+++ b/intern/ghost/intern/GHOST_DisplayManagerCocoa.h
@@ -87,11 +87,11 @@ class GHOST_DisplayManagerCocoa : public GHOST_DisplayManager {
const GHOST_DisplaySetting &setting);
protected:
- //Do not cache values as OS X supports screen hot plug
+ // Do not cache values as OS X supports screen hot
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list