diff options
Diffstat (limited to 'src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc')
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc | 67 |
1 files changed, 49 insertions, 18 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc index d764cde89d..49cbfc0654 100644 --- a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc @@ -38,7 +38,6 @@ \list \li \l {a-command} {\\a} - \li \l {abstract-command} {\\abstract} \li \l {annotatedlist-command} {\\annotatedlist} \li \l {b-command} {\\b} \span {class="newStuff"} \li \l {b-command} {\\bold} {(deprecated, use \\b)} @@ -68,6 +67,7 @@ \li \l {li-command} {\\li} \span {class="newStuff"} \li \l {list-command} {\\list} \li \l {meta-command} {\\meta} + \li \l {noautolist-command} {\\noautolist} \li \l {newcode-command} {\\newcode} \li \l {li-command} {\\o} \span {class="newStuff"} {(deprecated, use \\li)} \li \l {note-command} {\\note} @@ -1839,8 +1839,13 @@ \li \c {\l QWidget} - The name of a class documented with the \l {class-command} {\\class} command. - \li \c {\l QWidget::sizeHint()} - The name of a member function, - documented with or without an \l {fn-command} {\\fn} command. + \li \c {\l QWidget::sizeHint()} - The signature of a function without + parameters. If a matching function without parameters can't be found, + the link is satisfied with the first matching function found. + + \li \c {\l QWidget::removeAction(QAction* action)} - The signature + of a function with parameters. If an exact match is not found, the + link is not satisfied and qdoc reports a \e {Can't link to...} error. \li \c {\l <QtGlobal>} - The subject of a \l {headerfile-command} {\\headerfile} command. @@ -2092,8 +2097,11 @@ {sa-command} {\\sa (see also)} commands. The \\keyword command is like the \l {target-command} {\\target} - command, but stronger. A keyword can be linked from anywhere using - a simple syntax. + command, except when linking to keyword the link goes to the top of + the QDoc comment where the \\keyword appears in. If you want to + create a link target to a \c section unit within a \\page, use + \\target instead. A keyword can be linked from anywhere using a + simple syntax. Keywords must be unique over all the documents processed during the QDoc run. The command uses the rest of the line as its @@ -2886,19 +2894,6 @@ parts with a special rendering, conceptual meaning or function. - \target abstract-command - \section1 \\abstract - - The \\abstract and \\endabstract commands delimit a - document's abstract section. - - The abstract section is rendered as an indented italicized - paragraph. - - \warning The \b{\\abstract} and \b{\\endabstract} commands - have not been implemented. The abstract section is rendered as a - regular HTML paragraph. - \target quotation-command \section1 \\quotation @@ -3465,6 +3460,20 @@ with the \l {inmodule-command} {\\inmodule} command in its \\class comment. + \section2 \c qmltypesbymodule + + Similar to \c classesbymodule argument, but used for listing the + QML types from the QML module specified with the second argument. + + \note Support for this argument was introduced in QDoc 5.6. + + \section2 \c jstypesbymodule + + Similar to \c classesbymodule argument, but used for listing the + JavaScript types from the module specified with the second argument. + + \note Support for this argument was introduced in QDoc 5.6. + \section2 \c compatclasses The \c compatclasses argument generates a list in alphabetical @@ -3895,6 +3904,28 @@ values obtained from the QDoc configuration file. See \l {Generating DITA XML Output} for details. + \target noautolist-command + \section1 \\noautolist + + The \\noautolist command indicates that the annotated list of C++ + classes or QML types, which is automatically generated at the + bottom of the C++ or QML module page should be omitted, because + the classes or types have been listed manually. This command can + also be used with the \l {group-command}{\\group} command to omit + the list of group members, when they are listed manually. + + The command must stand on its own line. See \l {Qt Sensors QML Types} for + an example. The page is generated from \c {qtsensors5.qdoc}. There you will + find a qdoc comment containing the \c{\qmlmodule} command for the QtSensors + module. The same qdoc comment contains two \c {\annotated-list} commands to + list the QML types in two separate groups. The QML types have been divided + into these two groups because it makes more sense to list them this way than + it does to list them in a single alphabetical list. At the bottom of the + comment, \c {\noautolist} has been used to tell qdoc not to generate the + automatic annotated list. + + This command was introduced in QDoc 5.6. + \target omit-command \section1 \\omit |