Move documentation into header file

qgis · Nov 21, 2024 · 0a1f1cc · 0a1f1cc
1 parent 5f6259a
commit 0a1f1cc
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/src/app/3d/qgs3ddebugwidget.cpp b/src/app/3d/qgs3ddebugwidget.cpp
@@ -61,9 +61,6 @@ Qgs3DDebugWidget::Qgs3DDebugWidget( Qgs3DMapCanvas *canvas, QWidget *parent )
   mLookingZ->setRange( std::numeric_limits<float>::lowest(), std::numeric_limits<float>::max() );
 }
 
-/**
- * Sets up the interactive elements with values from Qgs3DMapSettings
- */
 void Qgs3DDebugWidget::setMapSettings( Qgs3DMapSettings *mapSettings )
 {
   mMap = mapSettings;
@@ -116,9 +113,6 @@ void Qgs3DDebugWidget::setMapSettings( Qgs3DMapSettings *mapSettings )
   } );
 }
 
-/**
-   * Update the state of navigation widget from camera's state
-   */
 void Qgs3DDebugWidget::updateFromCamera() const
 {
   mNearPlane->setValue( m3DMapCanvas->cameraController()->camera()->nearPlane() );

diff --git a/src/app/3d/qgs3ddebugwidget.h b/src/app/3d/qgs3ddebugwidget.h
@@ -28,9 +28,17 @@ class Qgs3DDebugWidget : public QWidget, Ui::Q3DDebugWidget
   public:
     explicit Qgs3DDebugWidget( Qgs3DMapCanvas *canvas, QWidget *parent = nullptr );
 
+    /**
+    * Sets the map settings and necessary connections based on Qgs3DMapSettings.
+    * \note We need separate function as Qgs3DMapCanvasWidget, which wraps this widget, also gets it later.
+    */
     void setMapSettings( Qgs3DMapSettings *mapSettings );
 
   public slots:
+
+    /**
+    * Function updates the camera info values when the user moves in the scene.
+    */
     void updateFromCamera() const;
 
   private: