Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2020-11-06 06:18:55 +0300
committerCampbell Barton <ideasman42@gmail.com>2020-11-06 06:25:44 +0300
commiteed6bf22a4f74136cd10159ea32b788ae93d7850 (patch)
tree0f05979fc3a199fc5c06a542292099a8ebf4a642 /intern/ghost/intern/GHOST_ContextCGL.h
parentf11f7ce08e92463b8a7495ed60082546f228cb60 (diff)
Cleanup: doxygen comments in ghost
Use colon after parameters, use hash to reference symbols.
Diffstat (limited to 'intern/ghost/intern/GHOST_ContextCGL.h')
-rw-r--r--intern/ghost/intern/GHOST_ContextCGL.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/intern/ghost/intern/GHOST_ContextCGL.h b/intern/ghost/intern/GHOST_ContextCGL.h
index 7b1e186dede..d499ec987b0 100644
--- a/intern/ghost/intern/GHOST_ContextCGL.h
+++ b/intern/ghost/intern/GHOST_ContextCGL.h
@@ -50,19 +50,19 @@ class GHOST_ContextCGL : public GHOST_Context {
/**
* Swaps front and back buffers of a window.
- * \return A boolean success indicator.
+ * \return A boolean success indicator.
*/
GHOST_TSuccess swapBuffers();
/**
* Activates the drawing context of this window.
- * \return A boolean success indicator.
+ * \return A boolean success indicator.
*/
GHOST_TSuccess activateDrawingContext();
/**
* Release the drawing context of the calling thread.
- * \return A boolean success indicator.
+ * \return A boolean success indicator.
*/
GHOST_TSuccess releaseDrawingContext();
@@ -82,15 +82,15 @@ class GHOST_ContextCGL : public GHOST_Context {
GHOST_TSuccess releaseNativeHandles();
/**
- * Sets the swap interval for swapBuffers.
- * \param interval The swap interval to use.
+ * Sets the swap interval for #swapBuffers.
+ * \param interval: The swap interval to use.
* \return A boolean success indicator.
*/
GHOST_TSuccess setSwapInterval(int interval);
/**
- * Gets the current swap interval for swapBuffers.
- * \param intervalOut Variable to store the swap interval if it can be read.
+ * Gets the current swap interval for #swapBuffers.
+ * \param intervalOut: Variable to store the swap interval if it can be read.
* \return Whether the swap interval can be read.
*/
GHOST_TSuccess getSwapInterval(int &);