diff options
Diffstat (limited to 'src/qdoc/doc/qdoc-guide/qtwritingstyle-qml.qdoc')
| -rw-r--r-- | src/qdoc/doc/qdoc-guide/qtwritingstyle-qml.qdoc | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/src/qdoc/doc/qdoc-guide/qtwritingstyle-qml.qdoc b/src/qdoc/doc/qdoc-guide/qtwritingstyle-qml.qdoc index ffc6d9b5a..b8350485a 100644 --- a/src/qdoc/doc/qdoc-guide/qtwritingstyle-qml.qdoc +++ b/src/qdoc/doc/qdoc-guide/qtwritingstyle-qml.qdoc @@ -151,7 +151,9 @@ marked with the \l{c-command}{\\c} command in the case of boolean values. QML enumerations are documented as QML properties with the \l{qmlproperty-command}{\\qmlproperty} command. The type of the property -is \c enumeration. +is \c enumeration. Use the \l{value-command}{\\value} command to document +the enum values. Add the type name as a prefix to each value, separated by +a period (.), as QDoc does not do this automatically. \snippet examples/qml.qdoc.sample enums |