modify comments for documentation generation

qgis · Dec 13, 2021 · ce12b3c · ce12b3c
1 parent 229921a
commit ce12b3c
Show file tree

Hide file tree

Showing 32 changed files with 244 additions and 135 deletions.
diff --git a/python/core/auto_generated/settings/qgssettingsentry.sip.in b/python/core/auto_generated/settings/qgssettingsentry.sip.in
diff --git a/python/gui/auto_generated/mesh/qgsmeshlayerproperties.sip.in b/python/gui/auto_generated/mesh/qgsmeshlayerproperties.sip.in
@@ -13,6 +13,7 @@
 class QgsMeshLayerProperties : QgsOptionsDialogBase
 {
 %Docstring(signature="appended")
+
 Property sheet for a mesh map layer.
 Contains information, source and style tabs
 

diff --git a/python/gui/auto_generated/tableeditor/qgstableeditorwidget.sip.in b/python/gui/auto_generated/tableeditor/qgstableeditorwidget.sip.in
@@ -355,8 +355,6 @@ Sets the column ``width`` (in millimeters) for the currently selected columns, o
     void setIncludeTableHeader( bool included );
 %Docstring
 Sets whether the table includes a header row.
-
-.. seealso:: :py:func:`includeTableHeader`
 %End
 
     void setTableHeaders( const QVariantList &headers );

diff --git a/python/gui/auto_generated/vector/qgsvectorlayerproperties.sip.in b/python/gui/auto_generated/vector/qgsvectorlayerproperties.sip.in
@@ -14,16 +14,6 @@
 
 class QgsVectorLayerProperties : QgsOptionsDialogBase
 {
-%Docstring(signature="appended")
-*************************************************************************
-
-This program is free software; you can redistribute it and/or modify  *
-it under the terms of the GNU General Public License as published by  *
-the Free Software Foundation; either version 2 of the License, or     *
-(at your option) any later version.                                   *
-
-**************************************************************************
-%End
 
 %TypeHeaderCode
 #include "qgsvectorlayerproperties.h"

diff --git a/src/core/providers/ogr/qgscplerrorhandler.h b/src/core/providers/ogr/qgscplerrorhandler.h
@@ -19,6 +19,10 @@
 #include "gdal.h"
 #include "qgsmessagelog.h"
 
+/**
+ * \ingroup core
+ * \class QgsCPLErrorHandler
+ */
 class QgsCPLErrorHandler
 {
     static void CPL_STDCALL showError( CPLErr errClass, int errNo, const char *msg )

diff --git a/src/core/settings/qgssettingsentry.h b/src/core/settings/qgssettingsentry.h
diff --git a/src/gui/mesh/qgsmeshdatasetgrouptreeview.h b/src/gui/mesh/qgsmeshdatasetgrouptreeview.h
@@ -35,6 +35,10 @@ SIP_NO_FILE
 
 class QgsMeshLayer;
 
+/**
+ * \ingroup gui
+ * \class QgsMeshDatasetGroupSaveMenu
+ */
 class QgsMeshDatasetGroupSaveMenu: public QObject
 {
     Q_OBJECT
@@ -54,7 +58,10 @@ class QgsMeshDatasetGroupSaveMenu: public QObject
 };
 
 /**
- * Item Model for QgsMeshDatasetGroupTreeItem
+ * \ingroup gui
+ * \class QgsMeshDatasetGroupTreeModel
+ *
+ * \brief Item Model for QgsMeshDatasetGroupTreeItem
  */
 class QgsMeshDatasetGroupTreeModel : public QAbstractItemModel
 {
@@ -113,6 +120,10 @@ class QgsMeshDatasetGroupTreeModel : public QAbstractItemModel
 
 };
 
+/**
+ * \ingroup gui
+ * \class QgsMeshAvailableDatasetGroupTreeModel
+ */
 class QgsMeshAvailableDatasetGroupTreeModel: public QgsMeshDatasetGroupTreeModel
 {
   public:
@@ -129,6 +140,10 @@ class QgsMeshAvailableDatasetGroupTreeModel: public QgsMeshDatasetGroupTreeModel
     QColor backGroundColor( const QModelIndex &index ) const;
 };
 
+/**
+ * \ingroup gui
+ * \class QgsMeshDatasetGroupProxyModel
+ */
 class  QgsMeshDatasetGroupProxyModel: public QSortFilterProxyModel
 {
   public:
@@ -161,7 +176,10 @@ class  QgsMeshDatasetGroupProxyModel: public QSortFilterProxyModel
 };
 
 /**
- * Delegate to display tree item with a contours and vector selector
+ * \ingroup gui
+ * \class QgsMeshDatasetGroupTreeItemDelagate
+ *
+ * \brief Delegate to display tree item with a contours and vector selector
  */
 class QgsMeshDatasetGroupTreeItemDelagate: public QStyledItemDelegate
 {
@@ -188,7 +206,10 @@ class QgsMeshDatasetGroupTreeItemDelagate: public QStyledItemDelegate
 };
 
 /**
- * Tree widget for display of the mesh dataset groups.
+ * \ingroup gui
+ * \class QgsMeshDatasetGroupTreeView
+ *
+ * \brief Tree widget for display of the mesh dataset groups.
  */
 class GUI_EXPORT QgsMeshDatasetGroupTreeView: public QTreeView
 {
@@ -224,7 +245,10 @@ class GUI_EXPORT QgsMeshDatasetGroupTreeView: public QTreeView
 };
 
 /**
- * Tree widget for display of the mesh dataset groups.
+ * \ingroup gui
+ * \class QgsMeshActiveDatasetGroupTreeView
+ *
+ * \brief Tree widget for display of the mesh dataset groups.
  *
  * One dataset group is selected (active)
  */
@@ -271,6 +295,10 @@ class GUI_EXPORT QgsMeshActiveDatasetGroupTreeView : public QTreeView
     QgsMeshLayer *mMeshLayer = nullptr; // not owned
 };
 
+/**
+ * \ingroup gui
+ * \class QgsMeshDatasetGroupListModel
+ */
 class GUI_EXPORT QgsMeshDatasetGroupListModel: public QAbstractListModel
 {
   public:

diff --git a/src/gui/mesh/qgsmeshdatasetgrouptreewidget.h b/src/gui/mesh/qgsmeshdatasetgrouptreewidget.h
@@ -25,6 +25,10 @@ SIP_NO_FILE
 
 class QgsMeshLayer;
 
+/**
+ * \ingroup gui
+ * \class QgsMeshDatasetGroupTreeWidget
+ */
 class GUI_EXPORT QgsMeshDatasetGroupTreeWidget: public QWidget, private Ui::QgsMeshDatasetGroupTreeWidgetBase
 {
     Q_OBJECT

diff --git a/src/gui/mesh/qgsmeshlayerproperties.h b/src/gui/mesh/qgsmeshlayerproperties.h
@@ -35,7 +35,10 @@ class QgsMapLayerConfigWidgetFactory;
 class QgsMetadataWidget;
 
 /**
- * Property sheet for a mesh map layer.
+ * \ingroup gui
+ * \class QgsMeshLayerProperties
+ *
+ * \brief Property sheet for a mesh map layer.
  * Contains information, source and style tabs
  *
  * \since QGIS 3.16 in the GUI API

diff --git a/src/gui/mesh/qgsmeshrenderer3daveragingwidget.h b/src/gui/mesh/qgsmeshrenderer3daveragingwidget.h
@@ -30,7 +30,10 @@ class QgsMeshLayer;
 class QgsMesh3dAveragingMethod;
 
 /**
- * A widget for setup of the averaging method from 3d to 2d datasets on 3d stacked mesh.
+ * \ingroup gui
+ * \class QgsMeshRenderer3dAveragingWidget
+ *
+ * \brief A widget for setup of the averaging method from 3d to 2d datasets on 3d stacked mesh.
  * The mesh layer must be connected
  */
 class QgsMeshRenderer3dAveragingWidget : public QWidget, private Ui::QgsMeshRenderer3dAveragingWidgetBase

diff --git a/src/gui/mesh/qgsmeshrendereractivedatasetwidget.h b/src/gui/mesh/qgsmeshrendereractivedatasetwidget.h
@@ -28,7 +28,10 @@ SIP_NO_FILE
 class QgsMeshLayer;
 
 /**
- * Widget for selection of active dataset group from tree view.
+ * \ingroup gui
+ * \class QgsMeshRendererActiveDatasetWidget
+ *
+ * \brief Widget for selection of active dataset group from tree view.
  * Also selects the active scalar and vector dataset by slider
  *
  * User can choose different scalar and vector dataset.

diff --git a/src/gui/mesh/qgsmeshrenderermeshsettingswidget.h b/src/gui/mesh/qgsmeshrenderermeshsettingswidget.h
@@ -27,7 +27,10 @@ SIP_NO_FILE
 class QgsMeshLayer;
 
 /**
- * A widget for setup of the mesh frame settings of
+ * \ingroup gui
+ * \class QgsMeshRendererMeshSettingsWidget
+ *
+ * \brief A widget for setup of the mesh frame settings of
  * the mesh layer. Can be used for native,
  * triangular and edge mesh renderer settings.
  */

diff --git a/src/gui/mesh/qgsmeshrendererscalarsettingswidget.h b/src/gui/mesh/qgsmeshrendererscalarsettingswidget.h
@@ -27,8 +27,11 @@ SIP_NO_FILE
 
 class QgsMeshLayer;
 
-/*!
- * A widget for setup of the scalar dataset renderer settings of
+/**
+ * \ingroup gui
+ * \class QgsMeshRendererScalarSettingsWidget
+ *
+ * \brief A widget for setup of the scalar dataset renderer settings of
  * a mesh layer. The layer must be connected and an active dataset
  * must be selected.
  */

diff --git a/src/gui/mesh/qgsmeshrenderervectorsettingswidget.h b/src/gui/mesh/qgsmeshrenderervectorsettingswidget.h
@@ -30,7 +30,10 @@ SIP_NO_FILE
 class QgsMeshLayer;
 
 /**
- * A widget for setup of the vector dataset renderer settings of
+ * \ingroup gui
+ * \class QgsMeshRendererVectorSettingsWidget
+ *
+ * \brief A widget for setup of the vector dataset renderer settings of
  * a mesh layer. The layer must be connected and an active dataset
  * must be selected.
  */

diff --git a/src/gui/mesh/qgsmeshstaticdatasetwidget.h b/src/gui/mesh/qgsmeshstaticdatasetwidget.h
@@ -26,9 +26,11 @@ SIP_NO_FILE
 class QgsMeshLayer;
 class QgsMeshDataProvider;
 
-
 /**
- * List model for dataset contained in dataset group,
+ * \ingroup gui
+ * \class QgsMeshDatasetListModel
+ *
+ * \brief List model for dataset contained in dataset group,
  * used to display by time dataset in widget
  */
 class QgsMeshDatasetListModel: public QAbstractListModel
@@ -51,7 +53,10 @@ class QgsMeshDatasetListModel: public QAbstractListModel
 };
 
 /**
- * A widget for setup of the static dataset of a mesh layer.
+ * \ingroup gui
+ * \class QgsMeshStaticDatasetWidget
+ *
+ * \brief A widget for setup of the static dataset of a mesh layer.
  */
 class GUI_EXPORT QgsMeshStaticDatasetWidget  : public QWidget, private Ui::QgsMeshStaticDatasetWidget
 {

diff --git a/src/gui/mesh/qgsmeshvariablestrokewidthwidget.h b/src/gui/mesh/qgsmeshvariablestrokewidthwidget.h
@@ -24,7 +24,10 @@
 SIP_NO_FILE
 
 /**
- * A widget push button that store variable stroke width and call a widget to set parameters
+ * \ingroup gui
+ * \class QgsMeshVariableStrokeWidthButton
+ *
+ * \brief A widget push button that store variable stroke width and call a widget to set parameters
  */
 class QgsMeshVariableStrokeWidthButton: public QPushButton
 {
@@ -57,7 +60,10 @@ class QgsMeshVariableStrokeWidthButton: public QPushButton
 };
 
 /**
- * A widget to set parameters of variable stroke width
+ * \ingroup gui
+ * \class QgsMeshVariableStrokeWidthWidget
+ *
+ * \brief A widget to set parameters of variable stroke width
  */
 class QgsMeshVariableStrokeWidthWidget: public QgsPanelWidget, public Ui::QgsMeshVariableStrokeWidthWidget
 {

diff --git a/src/gui/mesh/qgsrenderermeshpropertieswidget.h b/src/gui/mesh/qgsrenderermeshpropertieswidget.h
@@ -30,7 +30,10 @@ class QgsMeshLayer;
 class QgsMapCanvas;
 
 /**
- * Widget for renderer properties of the mesh, contours (scalars)
+ * \ingroup gui
+ * \class QgsRendererMeshPropertiesWidget
+ *
+ * \brief Widget for renderer properties of the mesh, contours (scalars)
  * and vectors data associated with the mesh layer
  */
 class GUI_EXPORT QgsRendererMeshPropertiesWidget : public QgsMapLayerConfigWidget, private Ui::QgsRendererMeshPropsWidgetBase

diff --git a/src/gui/tableeditor/qgstableeditorformattingwidget.h b/src/gui/tableeditor/qgstableeditorformattingwidget.h
@@ -71,7 +71,6 @@ class GUI_EXPORT QgsTableEditorFormattingWidget : public QgsPanelWidget, public
      * Sets the cell background \a color to show in the widget.
      *
      * \see backgroundColorChanged()
-     * \see setForegroundColor()
      */
     void setBackgroundColor( const QColor &color );
 

diff --git a/src/gui/tableeditor/qgstableeditorwidget.h b/src/gui/tableeditor/qgstableeditorwidget.h
@@ -429,8 +429,6 @@ class GUI_EXPORT QgsTableEditorWidget : public QTableWidget
 
     /**
      * Sets whether the table includes a header row.
-     *
-     * \see includeTableHeader()
      */
     void setIncludeTableHeader( bool included );
 

diff --git a/src/gui/vector/qgsattributeactiondialog.h b/src/gui/vector/qgsattributeactiondialog.h
@@ -35,6 +35,10 @@ back to QgsVectorLayer.
 class QgsActionManager;
 class QgsVectorLayer;
 
+/**
+ * \ingroup gui
+ * \class QgsAttributeActionDialog
+ */
 class GUI_EXPORT QgsAttributeActionDialog: public QWidget, private Ui::QgsAttributeActionDialogBase
 {
     Q_OBJECT

diff --git a/src/gui/vector/qgsattributeactionpropertiesdialog.h b/src/gui/vector/qgsattributeactionpropertiesdialog.h
@@ -28,6 +28,10 @@
 
 #include <QDialog>
 
+/**
+ * \ingroup gui
+ * \class QgsAttributeActionPropertiesDialog
+ */
 class GUI_EXPORT QgsAttributeActionPropertiesDialog: public QDialog, private Ui::QgsAttributeActionPropertiesDialogBase, public QgsExpressionContextGenerator
 {
     Q_OBJECT

diff --git a/src/gui/vector/qgsattributesforminitcode.h b/src/gui/vector/qgsattributesforminitcode.h
@@ -29,6 +29,10 @@
 
 class QDialog;
 
+/**
+ * \ingroup gui
+ * \class QgsAttributesFormInitCode
+ */
 class GUI_EXPORT QgsAttributesFormInitCode: public QDialog, private Ui::QgsAttributesFormInitCode
 {
     Q_OBJECT

diff --git a/src/gui/vector/qgsattributesformproperties.h b/src/gui/vector/qgsattributesformproperties.h
@@ -54,6 +54,10 @@ class QgsAttributeFormContainerEdit;
 class QgsAttributeTypeDialog;
 class QgsAttributeWidgetEdit;
 
+/**
+ * \ingroup gui
+ * \class QgsAttributesFormProperties
+ */
 class GUI_EXPORT QgsAttributesFormProperties : public QWidget, public QgsExpressionContextGenerator, private Ui_QgsAttributesFormProperties
 {
     Q_OBJECT
@@ -88,6 +92,10 @@ class GUI_EXPORT QgsAttributesFormProperties : public QWidget, public QgsExpress
       QString htmlCode;
     };
 
+    /**
+     * \ingroup gui
+     * \class DnDTreeItemData
+     */
     class DnDTreeItemData : public QTreeWidgetItem
     {
       public:
@@ -261,14 +269,16 @@ QDataStream &operator>> ( QDataStream &stream, QgsAttributesFormProperties::DnDT
 
 
 /**
- * This class overrides mime type handling to be able to work with
+ * \ingroup gui
+ * \class QgsAttributesDnDTree
+ *
+ * \brief This class overrides mime type handling to be able to work with
  * the drag and drop attribute editor.
  *
  * The mime type is application/x-qgsattributetablefield
  *
  * Graphical representation for the attribute editor drag and drop editor
  */
-
 class GUI_EXPORT QgsAttributesDnDTree : public QTreeWidget
 {
     Q_OBJECT

diff --git a/src/gui/vector/qgsdiagramproperties.cpp b/src/gui/vector/qgsdiagramproperties.cpp
@@ -52,6 +52,10 @@
 #include <QStyledItemDelegate>
 #include <QRandomGenerator>
 
+/**
+ * \ingroup gui
+ * \class EditBlockerDelegate
+ */
 class EditBlockerDelegate: public QStyledItemDelegate
 {
   public:

diff --git a/src/gui/vector/qgsdiagramproperties.h b/src/gui/vector/qgsdiagramproperties.h
@@ -33,6 +33,10 @@
 class QgsVectorLayer;
 class QgsMapCanvas;
 
+/**
+ * \ingroup gui
+ * \class QgsDiagramProperties
+ */
 class GUI_EXPORT QgsDiagramProperties : public QWidget, private Ui::QgsDiagramPropertiesBase, private QgsExpressionContextGenerator
 {
     Q_OBJECT