fix more dox

qgis · Jan 28, 2022 · 41ea405 · 41ea405
1 parent d8d824a
commit 41ea405
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/src/gui/maptools/qgsmaptoolcapturelayergeometry.h b/src/gui/maptools/qgsmaptoolcapturelayergeometry.h
@@ -23,7 +23,7 @@ class QgsMapCanvas;
 
 /**
  * \ingroup gui
- * QgsMapToolCaptureLayerGeometry is a base class for map tools digitizing layer geometries
+ * \brief QgsMapToolCaptureLayerGeometry is a base class for map tools digitizing layer geometries
  * It will implement avoid intersections
  * \since QGIS 3.24
  */

diff --git a/src/gui/maptools/qgsmaptoolshapeabstract.h b/src/gui/maptools/qgsmaptoolshapeabstract.h
@@ -34,7 +34,7 @@ class QKeyEvent;
 
 /**
  * \ingroup gui
- * QgsMapToolShapeAbstract is a base class for shape map tools to be use in QgsMapToolCapture
+ * \brief QgsMapToolShapeAbstract is a base class for shape map tools to be use in QgsMapToolCapture
  * \since QGIS 3.24
  */
 class GUI_EXPORT QgsMapToolShapeAbstract
@@ -63,6 +63,7 @@ class GUI_EXPORT QgsMapToolShapeAbstract
 
     virtual ~QgsMapToolShapeAbstract() = default;
 
+    //! Returns the id of the shape tool (equivalent to the one from the metadata)
     QString id() const {return mId;}
 
     /**

diff --git a/src/gui/maptools/qgsmaptoolshaperegistry.h b/src/gui/maptools/qgsmaptoolshaperegistry.h
@@ -29,7 +29,7 @@ class QgsMapToolCapture;
 
 /**
  * \ingroup gui
- * Keeps track of the registered shape map tools
+ * \brief Keeps track of the registered shape map tools
  * \since QGIS 3.24
  */
 class GUI_EXPORT QgsMapToolShapeRegistry
@@ -73,7 +73,7 @@ class GUI_EXPORT QgsMapToolShapeRegistry
 
 /**
  * \ingroup gui
- * QgsMapToolShapeMetadata is a base class for shape map tools metadata to be used in QgsMapToolShapeRegistry
+ * \brief QgsMapToolShapeMetadata is a base class for shape map tools metadata to be used in QgsMapToolShapeRegistry
  * \since QGIS 3.24
  */
 class GUI_EXPORT QgsMapToolShapeMetadata
@@ -93,6 +93,7 @@ class GUI_EXPORT QgsMapToolShapeMetadata
     //! Icon to be displayed in the toolbar
     virtual QIcon icon() const = 0;
 
+    //! Returns the shape category of the tool
     virtual QgsMapToolShapeAbstract::ShapeCategory category() const = 0;
 
     //! Creates the shape map tool for the given \a parentTool