Skip to content

Commit 7858b4c

Browse files
committed
add missing doc
1 parent 1e1d53f commit 7858b4c

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/core/qgsxmlutils.h

+9
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,15 @@ class CORE_EXPORT QgsXmlUtils
7979
*/
8080
static QVariant readVariant( const QDomElement &element );
8181

82+
/**
83+
* Read a flag value from an attribute of the element.
84+
* \param element the element to read the attribute from
85+
* \param attributeName the attribute name
86+
* \param defaultValue the default value as a flag
87+
* \note The flag value is a text as returned by \see QMetaEnum::valueToKeys.
88+
* The flag must have been declared with Q_ENUM macro.
89+
* \since QGIS 3.4
90+
*/
8291
template<class T> static T readFlagAttribute( const QDomElement &element, const QString &attributeName, T defaultValue ) SIP_SKIP
8392
{
8493
T value = defaultValue;

0 commit comments

Comments
 (0)