Add documentation

qgis · Nov 25, 2019 · 55df0c1 · 55df0c1
1 parent d631a77
commit 55df0c1
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/src/gui/editorwidgets/qgsvaluemapconfigdlg.h b/src/gui/editorwidgets/qgsvaluemapconfigdlg.h
@@ -40,8 +40,23 @@ class GUI_EXPORT QgsValueMapConfigDlg : public QgsEditorConfigWidget, private Ui
     QVariantMap config() override;
     void setConfig( const QVariantMap &config ) override;
 
+    /**
+     * Updates the displayed table with the values from \a map.
+     * If \a insertNull is set to TRUE, it will also insert a NULL value.
+     *
+     * \note In most cases the overload that accepts a list is preferred as it
+     * keeps the order of the values.
+     */
     void updateMap( const QMap<QString, QVariant> &map, bool insertNull );
-    void updateMap( const QList<QPair<QString, QVariant>> &map, bool insertNull );
+
+    /**
+     * Updates the displayed table with the values from \a list, the order of the values
+     * is preserved.
+     * If \a insertNull is set to TRUE, it will also insert a NULL value.
+     *
+     * \since QGIS 3.12
+     */
+    void updateMap( const QList<QPair<QString, QVariant>> &list, bool insertNull );
 
     /**
      * Populates a \a comboBox with the appropriate entries based on a value map \a configuration.