Misc doc cleanups

python/PyQt6/gui/auto_additions/qgssmartgroupeditordialog.py

@@ -1,4 +1,8 @@
 # The following has been generated automatically from src/gui/symbology/qgssmartgroupeditordialog.h
+try:
+    QgsSmartGroupCondition.__attribute_docs__ = {'removed': 'Emitted when the group with the specified ``id`` is removed.\n'}
+except NameError:
+    pass
 try:
     QgsSmartGroupCondition.__group__ = ['symbology']
 except NameError:

python/PyQt6/gui/auto_additions/qgssvgselectorwidget.py

@@ -1,6 +1,6 @@
 # The following has been generated automatically from src/gui/symbology/qgssvgselectorwidget.h
 try:
-    QgsSvgSelectorWidget.__attribute_docs__ = {'svgParametersChanged': 'Emitted when the parameters have changed\n\n.. versionadded:: 3.18\n'}
+    QgsSvgSelectorWidget.__attribute_docs__ = {'svgSelected': 'Emitted when an SVG is selected in the widget.\n', 'svgParametersChanged': 'Emitted when the parameters have changed\n\n.. versionadded:: 3.18\n'}
 except NameError:
     pass
 try:

python/PyQt6/gui/auto_additions/qgssymbolselectordialog.py

@@ -3,6 +3,10 @@ try:
     QgsSymbolSelectorWidget.__attribute_docs__ = {'symbolModified': 'Emitted when a symbol is modified in the widget.\n'}
 except NameError:
     pass
+try:
+    QgsSymbolSelectorDialog.__attribute_docs__ = {'symbolModified': 'Emitted when the symbol defined in the dialog is modified.\n'}
+except NameError:
+    pass
 try:
     QgsSymbolSelectorWidget.__group__ = ['symbology']
 except NameError:

python/PyQt6/gui/auto_additions/qgssymbolslistwidget.py

@@ -1,4 +1,8 @@
 # The following has been generated automatically from src/gui/symbology/qgssymbolslistwidget.h
+try:
+    QgsSymbolsListWidget.__attribute_docs__ = {'changed': 'Emitted when the symbol is modified in the widget.\n'}
+except NameError:
+    pass
 try:
     QgsSymbolsListWidget.__group__ = ['symbology']
 except NameError:

python/PyQt6/gui/auto_generated/qgssubsetstringeditorproviderregistry.sip.in

@@ -66,7 +66,7 @@ Returns a (possibly empty) list of providers by data ``providerkey``
     QgsSubsetStringEditorInterface *createDialog( QgsVectorLayer *layer, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags ) /TransferBack/;
 %Docstring
 Creates a new dialog to edit the subset string of the provided ``layer``.
-It will default to returning a :py:class:`QgsQueryBuilder`* if no provider was found.
+It will default to returning a :py:class:`QgsQueryBuilder` if no provider was found.
 The returned object must be destroyed by the caller.
 %End
 

python/PyQt6/gui/auto_generated/symbology/qgssmartgroupeditordialog.sip.in

@@ -46,7 +46,11 @@ sets the remove button hidden state to 'hide'
     void destruct();
 
   signals:
-    void removed( int );
+
+    void removed( int id );
+%Docstring
+Emitted when the group with the specified ``id`` is removed.
+%End
 
   protected:
 

python/PyQt6/gui/auto_generated/symbology/qgssvgselectorwidget.sip.in

@@ -99,6 +99,10 @@ not block the GUI.
 
 class QgsSvgSelectorWidget : QWidget
 {
+%Docstring(signature="appended")
+
+A widget allowing selection of an SVG file, and configuration of SVG related parameters.
+%End
 
 %TypeHeaderCode
 #include "qgssvgselectorwidget.h"
@@ -186,7 +190,11 @@ Sets the dynamic parameters
 %End
 
   signals:
+
     void svgSelected( const QString &path );
+%Docstring
+Emitted when an SVG is selected in the widget.
+%End
 
     void svgParametersChanged( const QMap<QString, QgsProperty> &parameters );
 %Docstring

python/PyQt6/gui/auto_generated/symbology/qgssymbolselectordialog.sip.in

@@ -148,6 +148,9 @@ Emitted when a symbol is modified in the widget.
 
 class QgsSymbolSelectorDialog : QDialog
 {
+%Docstring(signature="appended")
+A dialog that can be used to select and build a symbol.
+%End
 
 %TypeHeaderCode
 #include "qgssymbolselectordialog.h"
@@ -243,6 +246,9 @@ Alters tree and sets proper widget when Layer Type is changed
   signals:
 
     void symbolModified();
+%Docstring
+Emitted when the symbol defined in the dialog is modified.
+%End
 
 };
 

python/PyQt6/gui/auto_generated/symbology/qgssymbolslistwidget.sip.in

@@ -68,7 +68,11 @@ Returns the vector layer associated with the widget.
     void updateDataDefinedLineWidth();
 
   signals:
+
     void changed();
+%Docstring
+Emitted when the symbol is modified in the widget.
+%End
 
 };
 

python/gui/auto_additions/qgssmartgroupeditordialog.py

@@ -1,4 +1,8 @@
 # The following has been generated automatically from src/gui/symbology/qgssmartgroupeditordialog.h
+try:
+    QgsSmartGroupCondition.__attribute_docs__ = {'removed': 'Emitted when the group with the specified ``id`` is removed.\n'}
+except NameError:
+    pass
 try:
     QgsSmartGroupCondition.__group__ = ['symbology']
 except NameError:

python/gui/auto_additions/qgssvgselectorwidget.py

@@ -1,6 +1,6 @@
 # The following has been generated automatically from src/gui/symbology/qgssvgselectorwidget.h
 try:
-    QgsSvgSelectorWidget.__attribute_docs__ = {'svgParametersChanged': 'Emitted when the parameters have changed\n\n.. versionadded:: 3.18\n'}
+    QgsSvgSelectorWidget.__attribute_docs__ = {'svgSelected': 'Emitted when an SVG is selected in the widget.\n', 'svgParametersChanged': 'Emitted when the parameters have changed\n\n.. versionadded:: 3.18\n'}
 except NameError:
     pass
 try:

python/gui/auto_additions/qgssymbolselectordialog.py

@@ -3,6 +3,10 @@ try:
     QgsSymbolSelectorWidget.__attribute_docs__ = {'symbolModified': 'Emitted when a symbol is modified in the widget.\n'}
 except NameError:
     pass
+try:
+    QgsSymbolSelectorDialog.__attribute_docs__ = {'symbolModified': 'Emitted when the symbol defined in the dialog is modified.\n'}
+except NameError:
+    pass
 try:
     QgsSymbolSelectorWidget.__group__ = ['symbology']
 except NameError:

python/gui/auto_additions/qgssymbolslistwidget.py

@@ -1,4 +1,8 @@
 # The following has been generated automatically from src/gui/symbology/qgssymbolslistwidget.h
+try:
+    QgsSymbolsListWidget.__attribute_docs__ = {'changed': 'Emitted when the symbol is modified in the widget.\n'}
+except NameError:
+    pass
 try:
     QgsSymbolsListWidget.__group__ = ['symbology']
 except NameError:

python/gui/auto_generated/qgssubsetstringeditorproviderregistry.sip.in

@@ -66,7 +66,7 @@ Returns a (possibly empty) list of providers by data ``providerkey``
     QgsSubsetStringEditorInterface *createDialog( QgsVectorLayer *layer, QWidget *parent /TransferThis/ = 0, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags ) /TransferBack/;
 %Docstring
 Creates a new dialog to edit the subset string of the provided ``layer``.
-It will default to returning a :py:class:`QgsQueryBuilder`* if no provider was found.
+It will default to returning a :py:class:`QgsQueryBuilder` if no provider was found.
 The returned object must be destroyed by the caller.
 %End
 

python/gui/auto_generated/symbology/qgssmartgroupeditordialog.sip.in

@@ -46,7 +46,11 @@ sets the remove button hidden state to 'hide'
     void destruct();
 
   signals:
-    void removed( int );
+
+    void removed( int id );
+%Docstring
+Emitted when the group with the specified ``id`` is removed.
+%End
 
   protected:
 

python/gui/auto_generated/symbology/qgssvgselectorwidget.sip.in

@@ -99,6 +99,10 @@ not block the GUI.
 
 class QgsSvgSelectorWidget : QWidget
 {
+%Docstring(signature="appended")
+
+A widget allowing selection of an SVG file, and configuration of SVG related parameters.
+%End
 
 %TypeHeaderCode
 #include "qgssvgselectorwidget.h"
@@ -186,7 +190,11 @@ Sets the dynamic parameters
 %End
 
   signals:
+
     void svgSelected( const QString &path );
+%Docstring
+Emitted when an SVG is selected in the widget.
+%End
 
     void svgParametersChanged( const QMap<QString, QgsProperty> &parameters );
 %Docstring

python/gui/auto_generated/symbology/qgssymbolselectordialog.sip.in

@@ -148,6 +148,9 @@ Emitted when a symbol is modified in the widget.
 
 class QgsSymbolSelectorDialog : QDialog
 {
+%Docstring(signature="appended")
+A dialog that can be used to select and build a symbol.
+%End
 
 %TypeHeaderCode
 #include "qgssymbolselectordialog.h"
@@ -243,6 +246,9 @@ Alters tree and sets proper widget when Layer Type is changed
   signals:
 
     void symbolModified();
+%Docstring
+Emitted when the symbol defined in the dialog is modified.
+%End
 
 };
 

python/gui/auto_generated/symbology/qgssymbolslistwidget.sip.in

@@ -68,7 +68,11 @@ Returns the vector layer associated with the widget.
     void updateDataDefinedLineWidth();
 
   signals:
+
     void changed();
+%Docstring
+Emitted when the symbol is modified in the widget.
+%End
 
 };
 

src/gui/qgssubsetstringeditorproviderregistry.h

@@ -73,7 +73,7 @@ class GUI_EXPORT QgsSubsetStringEditorProviderRegistry
 
     /**
      * Creates a new dialog to edit the subset string of the provided \a layer.
-     * It will default to returning a QgsQueryBuilder* if no provider was found.
+     * It will default to returning a QgsQueryBuilder if no provider was found.
      * The returned object must be destroyed by the caller.
      */
     QgsSubsetStringEditorInterface *createDialog( QgsVectorLayer *layer, QWidget *parent SIP_TRANSFERTHIS = nullptr, Qt::WindowFlags fl = QgsGuiUtils::ModalDialogFlags ) SIP_TRANSFERBACK;

src/gui/symbology/qgssmartgroupeditordialog.h

@@ -50,7 +50,11 @@ class GUI_EXPORT QgsSmartGroupCondition : public QWidget, private Ui::QgsSmartGr
     void destruct();
 
   signals:
-    void removed( int );
+
+    /**
+     * Emitted when the group with the specified \a id is removed.
+     */
+    void removed( int id );
 
   protected:
     int mConditionId;

src/gui/symbology/qgssvgselectorwidget.h

@@ -373,6 +373,8 @@ class GUI_EXPORT QgsSvgSelectorGroupsModel : public QStandardItemModel
 /**
  * \ingroup gui
  * \class QgsSvgSelectorWidget
+ *
+ * \brief A widget allowing selection of an SVG file, and configuration of SVG related parameters.
  */
 class GUI_EXPORT QgsSvgSelectorWidget : public QWidget, private Ui::WidgetSvgSelector
 {
@@ -445,6 +447,10 @@ class GUI_EXPORT QgsSvgSelectorWidget : public QWidget, private Ui::WidgetSvgSel
     void setSvgParameters( const QMap<QString, QgsProperty> &parameters );
 
   signals:
+
+    /**
+     * Emitted when an SVG is selected in the widget.
+     */
     void svgSelected( const QString &path );
 
     /**

src/gui/symbology/qgssymbolselectordialog.h

@@ -286,6 +286,7 @@ class GUI_EXPORT QgsSymbolSelectorWidget: public QgsPanelWidget, private Ui::Qgs
 /**
  * \ingroup gui
  * \class QgsSymbolSelectorDialog
+ * \brief A dialog that can be used to select and build a symbol.
  */
 class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog
 {
@@ -380,6 +381,9 @@ class GUI_EXPORT QgsSymbolSelectorDialog : public QDialog
 
   signals:
 
+    /**
+     * Emitted when the symbol defined in the dialog is modified.
+     */
     void symbolModified();
 
   private:

src/gui/symbology/qgssymbolslistwidget.h

@@ -83,6 +83,10 @@ class GUI_EXPORT QgsSymbolsListWidget : public QWidget, private Ui::SymbolsListW
     void updateDataDefinedLineWidth();
 
   signals:
+
+    /**
+     * Emitted when the symbol is modified in the widget.
+     */
     void changed();
 
   private slots: