diff options
Diffstat (limited to 'src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc')
| -rw-r--r-- | src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc | 9 |
1 files changed, 2 insertions, 7 deletions
diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc index fd6dc7a75..201706b70 100644 --- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc +++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc @@ -541,26 +541,21 @@ For example, if a type called \c TabWidget is in the \c UIComponents module, it must be linked as \c {UIComponents::TabWidget}. - The \l{componentset}{UIComponents} example demonstrates proper usage of - QDoc commands to document QML types and QML modules. - \section3 Read-only and Internal QML Properties QDoc detects QML properties that are marked as \c readonly. Note that the property must be initialized with a value. - \code + \badcode readonly property int sampleReadOnlyProperty: 0 \endcode - For example, the example \l{TabWidget} type has a fictitious read-only - property \c sampleReadOnlyProperty. Its declaration has the \c readonly - identifier and it has an initial value. Properties and signals that are not meant for the public interface may be marked with the \l{internal-command}{\\internal} command. QDoc will not publish the documentation in the generated outputs. \section1 Articles & Overviews + Articles and overviews are a style of writing best used for providing summary detail on a topic or concept. It may introduce a technology or discuss how a concept may be applied, but without discussing exact steps |