From 88ee650263cb8f0670a9d3837f43325009b55115 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sat, 16 Aug 2014 10:51:07 +1000 Subject: Comments --- intern/ghost/GHOST_C-api.h | 6 +-- intern/ghost/GHOST_ISystem.h | 68 +++++++++++++++---------------- intern/ghost/GHOST_IWindow.h | 13 +++--- intern/ghost/GHOST_Rect.h | 2 +- intern/ghost/intern/GHOST_DropTargetX11.h | 2 +- intern/ghost/intern/GHOST_System.h | 6 +-- intern/ghost/intern/GHOST_SystemX11.cpp | 2 +- intern/ghost/intern/GHOST_WindowManager.h | 2 +- intern/guardedalloc/MEM_guardedalloc.h | 2 +- 9 files changed, 48 insertions(+), 55 deletions(-) (limited to 'intern') diff --git a/intern/ghost/GHOST_C-api.h b/intern/ghost/GHOST_C-api.h index 7428acee17e..c877a3b8fad 100644 --- a/intern/ghost/GHOST_C-api.h +++ b/intern/ghost/GHOST_C-api.h @@ -151,7 +151,7 @@ extern void GHOST_GetMainDisplayDimensions(GHOST_SystemHandle systemhandle, /** * Returns the dimensions of all displays combine * (the current workspace). - * No need to worrky about overlapping monitors. + * No need to worry about overlapping monitors. * \param systemhandle The handle to the system * \param width A pointer the width gets put in * \param height A pointer the height gets put in @@ -751,7 +751,7 @@ 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, emapty 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 intean value (true == valid rectangle) */ @@ -845,7 +845,7 @@ extern GHOST_TSuccess GHOST_ClipRectangle(GHOST_RectangleHandle rectanglehandle, GHOST_RectangleHandle anotherrectanglehandle); /** - * Return the data from the clipboad + * Return the data from the clipboard * \param selection Boolean to return the selection instead, X11 only feature. * \return clipboard data */ diff --git a/intern/ghost/GHOST_ISystem.h b/intern/ghost/GHOST_ISystem.h index 137926b033c..19f36319949 100644 --- a/intern/ghost/GHOST_ISystem.h +++ b/intern/ghost/GHOST_ISystem.h @@ -48,7 +48,7 @@ class GHOST_IEventConsumer; * * GHOST is yet another acronym. It stands for "Generic Handy Operating System * Toolkit". It has been created to replace the OpenGL utility tool kit - * GLUT. + * GLUT. * GLUT was used in Blender until the * point that Blender needed to be ported to Apple's Mac OSX. Blender needed a * number of modifications in GLUT to work but the GLUT sources for OSX were @@ -60,31 +60,29 @@ class GHOST_IEventConsumer; * In short: everything that Blender needed from GLUT to run on all it's supported * operating systems and some extra's. * This includes : - * + * + * - Time(r) management. + * - Display/window management (windows are only created on the main display). + * - Event management. + * - Cursor shape management (no custom cursors for now). + * - 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). + * - Video mode switching. + * - Copy/Paste buffers. + * - System paths. + * * Font management has been moved to a separate library. * * \section platforms Platforms * * GHOST supports the following platforms: - * + * + * - OSX Cocoa. + * - Windows. + * - X11. + * - SDL2 (experimental). + * - NULL (headless mode). * * \section Building GHOST * @@ -92,23 +90,23 @@ class GHOST_IEventConsumer; * * \section interface Interface * GHOST has two programming interfaces: - * - * GHOST itself is writtem in C++ and the C-API is a wrapper around the C++ + * + * - The C-API. For programs written in C. + * - The C++-API. For programs written in C++. + * + * GHOST itself is written in C++ and the C-API is a wrapper around the C++ * API. * * \subsection cplusplus_api The C++ API consists of the following files: - * + * + * - GHOST_IEvent.h + * - GHOST_IEventConsumer.h + * - GHOST_ISystem.h + * - GHOST_ITimerTask.h + * - GHOST_IWindow.h + * - GHOST_Rect.h + * - GHOST_Types.h + * * For an example of using the C++-API, have a look at the GHOST_C-Test.cpp * program in the ?/ghost/test/gears/ directory. * diff --git a/intern/ghost/GHOST_IWindow.h b/intern/ghost/GHOST_IWindow.h index 35577075263..c6befff6871 100644 --- a/intern/ghost/GHOST_IWindow.h +++ b/intern/ghost/GHOST_IWindow.h @@ -46,13 +46,12 @@ * \see GHOST_ISystem#createWindow * * There are two coordinate systems: - * + * + * - The screen coordinate system. The origin of the screen is located in the + * upper left corner of the screen. + * - The client rectangle coordinate system. The client rectangle of a window + * is the area that is drawable by the application (excluding title bars etc.). + * * \author Maarten Gribnau * \date May 31, 2001 */ diff --git a/intern/ghost/GHOST_Rect.h b/intern/ghost/GHOST_Rect.h index a055b6f7f0d..c2ea8db0a66 100644 --- a/intern/ghost/GHOST_Rect.h +++ b/intern/ghost/GHOST_Rect.h @@ -102,7 +102,7 @@ public: /** * Returns whether this rectangle is valid. - * Valid rectangles are rectangles that have m_l <= m_r and m_t <= m_b. Thus, emapty 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; diff --git a/intern/ghost/intern/GHOST_DropTargetX11.h b/intern/ghost/intern/GHOST_DropTargetX11.h index 9ac45ba8dfe..4670c2e5b4b 100644 --- a/intern/ghost/intern/GHOST_DropTargetX11.h +++ b/intern/ghost/intern/GHOST_DropTargetX11.h @@ -101,7 +101,7 @@ private: /** * Fully decode file URL (i.e. converts "file:///a%20b/test" to "/a b/test") * \param fileUrl - file path URL to be fully decoded - * \return decoded file path (resutl shold be free-d) + * \return decoded file path (resutl should be free-d) */ char *FileUrlDecode(char *fileUrl); diff --git a/intern/ghost/intern/GHOST_System.h b/intern/ghost/intern/GHOST_System.h index ec0022f0a7d..79230b0f505 100644 --- a/intern/ghost/intern/GHOST_System.h +++ b/intern/ghost/intern/GHOST_System.h @@ -250,27 +250,23 @@ public: virtual GHOST_TSuccess pushEvent(GHOST_IEvent *event); /** - * Returns the timer manager. * \return The timer manager. */ inline virtual GHOST_TimerManager *getTimerManager() const; /** - * Returns a pointer to our event manager. * \return A pointer to our event manager. */ virtual inline GHOST_EventManager *getEventManager() const; /** - * Returns a pointer to our window manager. * \return A pointer to our window manager. */ virtual inline GHOST_WindowManager *getWindowManager() const; #ifdef WITH_INPUT_NDOF /** - * Returns a pointer to our n-degree of freedeom manager. - * \return A pointer to our n-degree of freedeom manager. + * \return A pointer to our n-degree of freedom manager. */ virtual inline GHOST_NDOFManager *getNDOFManager() const; #endif diff --git a/intern/ghost/intern/GHOST_SystemX11.cpp b/intern/ghost/intern/GHOST_SystemX11.cpp index 16ebdc377ea..f797d8074e1 100644 --- a/intern/ghost/intern/GHOST_SystemX11.cpp +++ b/intern/ghost/intern/GHOST_SystemX11.cpp @@ -670,7 +670,7 @@ GHOST_SystemX11::processEvent(XEvent *xe) #ifdef WITH_X11_XINPUT /* Proximity-Out Events are not reliable, if the tablet is active - check on each event * this adds a little overhead but only while the tablet is in use. - * in the futire we could have a ghost call window->CheckTabletProximity() + * in the future we could have a ghost call window->CheckTabletProximity() * but for now enough parts of the code are checking 'Active' * - campbell */ if (window->GetTabletData()->Active != GHOST_kTabletModeNone) { diff --git a/intern/ghost/intern/GHOST_WindowManager.h b/intern/ghost/intern/GHOST_WindowManager.h index 79438c03702..8297e4d24d2 100644 --- a/intern/ghost/intern/GHOST_WindowManager.h +++ b/intern/ghost/intern/GHOST_WindowManager.h @@ -87,7 +87,7 @@ public: /** * Returns pointer to the full-screen window. - * \return The fll-screen window (0 if not in full-screen). + * \return The full-screen window (NULL if not in full-screen). */ virtual GHOST_IWindow *getFullScreenWindow(void) const; diff --git a/intern/guardedalloc/MEM_guardedalloc.h b/intern/guardedalloc/MEM_guardedalloc.h index 8c5ad77b8b6..3b56362e3d6 100644 --- a/intern/guardedalloc/MEM_guardedalloc.h +++ b/intern/guardedalloc/MEM_guardedalloc.h @@ -76,7 +76,7 @@ extern "C" { extern size_t (*MEM_allocN_len)(const void *vmemh) ATTR_WARN_UNUSED_RESULT; /** - * Release memory previously allocatred by this module. + * Release memory previously allocated by this module. */ extern void (*MEM_freeN)(void *vmemh); -- cgit v1.2.3