[Bf-blender-cvs] [b147af2b7ee] master: Cleanup: remove duplicate doc-strings

Campbell Barton noreply at git.blender.org
Thu Dec 15 04:57:26 CET 2022


Commit: b147af2b7ee4a995a9a444f864bcbb2ad03f9c4f
Author: Campbell Barton
Date:   Thu Dec 15 14:56:58 2022 +1100
Branches: master
https://developer.blender.org/rBb147af2b7ee4a995a9a444f864bcbb2ad03f9c4f

Cleanup: remove duplicate doc-strings

===================================================================

M	intern/ghost/intern/GHOST_SystemX11.cpp
M	intern/ghost/intern/GHOST_WindowWayland.cpp
M	intern/ghost/intern/GHOST_WindowX11.cpp

===================================================================

diff --git a/intern/ghost/intern/GHOST_SystemX11.cpp b/intern/ghost/intern/GHOST_SystemX11.cpp
index 4baa3ff598f..72f34dac52e 100644
--- a/intern/ghost/intern/GHOST_SystemX11.cpp
+++ b/intern/ghost/intern/GHOST_SystemX11.cpp
@@ -275,10 +275,6 @@ uint8_t GHOST_SystemX11::getNumDisplays() const
   return uint8_t(1);
 }
 
-/**
- * Returns the dimensions of the main display on this system.
- * \return The dimension of the main display.
- */
 void GHOST_SystemX11::getMainDisplayDimensions(uint32_t &width, uint32_t &height) const
 {
   if (m_display) {
@@ -289,10 +285,6 @@ void GHOST_SystemX11::getMainDisplayDimensions(uint32_t &width, uint32_t &height
   }
 }
 
-/**
- * Returns the dimensions of the main display on this system.
- * \return The dimension of the main display.
- */
 void GHOST_SystemX11::getAllDisplayDimensions(uint32_t &width, uint32_t &height) const
 {
   if (m_display) {
@@ -301,22 +293,6 @@ void GHOST_SystemX11::getAllDisplayDimensions(uint32_t &width, uint32_t &height)
   }
 }
 
-/**
- * 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 glSettings: Misc OpenGL settings.
- * \param exclusive: Use to show the window on top and ignore others (used full-screen).
- * \param parentWindow: Parent window.
- * \return The new window (or 0 if creation failed).
- */
 GHOST_IWindow *GHOST_SystemX11::createWindow(const char *title,
                                              int32_t left,
                                              int32_t top,
@@ -417,11 +393,7 @@ static GHOST_Context *create_glx_context(Display *display,
 
   return nullptr;
 }
-/**
- * Create a new off-screen context.
- * Never explicitly delete the context, use #disposeContext() instead.
- * \return The new context (or 0 if creation failed).
- */
+
 GHOST_IContext *GHOST_SystemX11::createOffscreenContext(GHOST_GLSettings glSettings)
 {
   /* During development:
@@ -479,11 +451,6 @@ GHOST_IContext *GHOST_SystemX11::createOffscreenContext(GHOST_GLSettings glSetti
   return nullptr;
 }
 
-/**
- * Dispose of a context.
- * \param context: Pointer to the context to be disposed.
- * \return Indication of success.
- */
 GHOST_TSuccess GHOST_SystemX11::disposeContext(GHOST_IContext *context)
 {
   delete context;
diff --git a/intern/ghost/intern/GHOST_WindowWayland.cpp b/intern/ghost/intern/GHOST_WindowWayland.cpp
index 239693e0e5b..ffbb8370c46 100644
--- a/intern/ghost/intern/GHOST_WindowWayland.cpp
+++ b/intern/ghost/intern/GHOST_WindowWayland.cpp
@@ -1203,10 +1203,6 @@ void GHOST_WindowWayland::setOpaque() const
 }
 #endif
 
-/**
- * \param type: The type of rendering context create.
- * \return Indication of success.
- */
 GHOST_Context *GHOST_WindowWayland::newDrawingContext(GHOST_TDrawingContextType type)
 {
   GHOST_Context *context;
diff --git a/intern/ghost/intern/GHOST_WindowX11.cpp b/intern/ghost/intern/GHOST_WindowX11.cpp
index 9f77bdc4dd0..00b0230888e 100644
--- a/intern/ghost/intern/GHOST_WindowX11.cpp
+++ b/intern/ghost/intern/GHOST_WindowX11.cpp
@@ -1112,11 +1112,6 @@ void GHOST_WindowX11::validate()
   m_invalid_window = false;
 }
 
-/**
- * Destructor.
- * Closes the window and disposes resources allocated.
- */
-
 GHOST_WindowX11::~GHOST_WindowX11()
 {
   std::map<uint, Cursor>::iterator it = m_standard_cursors.begin();



More information about the Bf-blender-cvs mailing list