add missing doc

qgis · Oct 4, 2018 · 7858b4c · 7858b4c
1 parent 1e1d53f
commit 7858b4c
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/core/qgsxmlutils.h b/src/core/qgsxmlutils.h
@@ -79,6 +79,15 @@ class CORE_EXPORT QgsXmlUtils
      */
     static QVariant readVariant( const QDomElement &element );
 
+    /**
+     * Read a flag value from an attribute of the element.
+     * \param element the element to read the attribute from
+     * \param attributeName the attribute name
+     * \param defaultValue the default value as a flag
+     * \note The flag value is a text as returned by \see QMetaEnum::valueToKeys.
+     *       The flag must have been declared with Q_ENUM macro.
+     * \since QGIS 3.4
+     */
     template<class T> static T readFlagAttribute( const QDomElement &element, const QString &attributeName, T defaultValue ) SIP_SKIP
     {
       T value = defaultValue;