Add missing docs

qgis · Jan 23, 2017 · b586330 · b586330
1 parent 0d9b223
commit b586330
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 8 deletions.
diff --git a/src/core/qgsdiagramrenderer.h b/src/core/qgsdiagramrenderer.h
@@ -95,6 +95,9 @@ class CORE_EXPORT QgsDiagramLayerSettings
       StartAngle, //! Angle offset for pie diagram
     };
 
+    /**
+     * Constructor for QgsDiagramLayerSettings.
+     */
     QgsDiagramLayerSettings() = default;
 
     //! Copy constructor
@@ -238,7 +241,16 @@ class CORE_EXPORT QgsDiagramLayerSettings
      */
     void setShowAllDiagrams( bool showAllDiagrams ) { mShowAll = showAllDiagrams; }
 
+    /**
+     * Reads the diagram settings from a DOM element.
+     * @see writeXml()
+     */
     void readXml( const QDomElement& elem, const QgsVectorLayer* layer );
+
+    /**
+     * Writes the diagram settings to a DOM element.
+     * @see readXml()
+     */
     void writeXml( QDomElement& layerElem, QDomDocument& doc, const QgsVectorLayer* layer ) const;
 
     /**

diff --git a/src/core/qgspallabeling.h b/src/core/qgspallabeling.h
@@ -786,23 +786,23 @@ class CORE_EXPORT QgsPalLabeling
     static QStringList splitToGraphemes( const QString& text );
 
   protected:
-    // update temporary QgsPalLayerSettings with any data defined text style values
+    //! Update temporary QgsPalLayerSettings with any data defined text style values
     static void dataDefinedTextStyle( QgsPalLayerSettings& tmpLyr,
                                       const QMap< QgsPalLayerSettings::Property, QVariant >& ddValues );
 
-    // update temporary QgsPalLayerSettings with any data defined text formatting values
+    //! Update temporary QgsPalLayerSettings with any data defined text formatting values
     static void dataDefinedTextFormatting( QgsPalLayerSettings& tmpLyr,
                                            const QMap< QgsPalLayerSettings::Property, QVariant >& ddValues );
 
-    // update temporary QgsPalLayerSettings with any data defined text buffer values
+    //! Update temporary QgsPalLayerSettings with any data defined text buffer values
     static void dataDefinedTextBuffer( QgsPalLayerSettings& tmpLyr,
                                        const QMap< QgsPalLayerSettings::Property, QVariant >& ddValues );
 
-    // update temporary QgsPalLayerSettings with any data defined shape background values
+    //! Update temporary QgsPalLayerSettings with any data defined shape background values
     static void dataDefinedShapeBackground( QgsPalLayerSettings& tmpLyr,
                                             const QMap< QgsPalLayerSettings::Property, QVariant >& ddValues );
 
-    // update temporary QgsPalLayerSettings with any data defined drop shadow values
+    //! Update temporary QgsPalLayerSettings with any data defined drop shadow values
     static void dataDefinedDropShadow( QgsPalLayerSettings& tmpLyr,
                                        const QMap< QgsPalLayerSettings::Property, QVariant >& ddValues );
 

diff --git a/src/gui/symbology-ng/qgslayerpropertieswidget.h b/src/gui/symbology-ng/qgslayerpropertieswidget.h
@@ -78,6 +78,12 @@ class GUI_EXPORT QgsLayerPropertiesWidget : public QgsPanelWidget, protected Qgs
 
     QgsExpressionContext createExpressionContext() const override;
 
+    /**
+     * Registers a data defined override button. Handles setting up connections
+     * for the button and initializing the button to show the correct descriptions
+     * and help text for the associated property.
+     * @note added in QGIS 3.0
+     */
     void registerDataDefinedButton( QgsPropertyOverrideButton *button, QgsSymbolLayer::Property key );
 
   protected: // data
@@ -86,12 +92,10 @@ class GUI_EXPORT QgsLayerPropertiesWidget : public QgsPanelWidget, protected Qgs
     const QgsSymbol* mSymbol;
     const QgsVectorLayer* mVectorLayer;
 
-  protected slots:
-    void updateProperty();
-
   private slots:
     void reloadLayer();
     void on_mEnabledCheckBox_toggled( bool enabled );
+    void updateProperty();
 
   private:
 

diff --git a/src/gui/symbology-ng/qgssymbollayerwidget.h b/src/gui/symbology-ng/qgssymbollayerwidget.h
@@ -63,6 +63,12 @@ class GUI_EXPORT QgsSymbolLayerWidget : public QWidget, protected QgsExpressionC
 
   protected:
 
+    /**
+     * Registers a data defined override button. Handles setting up connections
+     * for the button and initializing the button to show the correct descriptions
+     * and help text for the associated property.
+     * @note added in QGIS 3.0
+     */
     void registerDataDefinedButton( QgsPropertyOverrideButton* button, QgsSymbolLayer::Property key );
 
     QgsExpressionContext createExpressionContext() const override;