diff options
Diffstat (limited to 'src/tools/qdoc/doc')
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc | 1 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc | 73 | ||||
-rw-r--r-- | src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc | 14 |
3 files changed, 47 insertions, 41 deletions
diff --git a/src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc b/src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc index 87416fcd14..63fcee6469 100644 --- a/src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-cmdindex.qdoc @@ -106,6 +106,7 @@ \li \l {printto-command} {\\printto} \li \l {printuntil-command} {\\printuntil} \li \l {property-command} {\\property} + \li \l {qmlabstract-command} {\\qmlabstract} \li \l {qmlattachedproperty-command} {\\qmlattachedproperty} \li \l {qmlattachedsignal-command} {\\qmlattachedsignal} \li \l {qmlbasictype-command} {\\qmlbasictype} diff --git a/src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc index 77987d6d95..3bf63214ad 100644 --- a/src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc +++ b/src/tools/qdoc/doc/qdoc-manual-contextcmds.qdoc @@ -46,6 +46,7 @@ below the \l {Topic Commands} {topic} command. \list + \li \l {abstract-command} {\\abstract} \li \l {compat-command}{\\compat}, \li \l {contentspage-command}{\\contentspage}, \li \l {indexpage-command}{\\indexpage}, @@ -59,6 +60,7 @@ \li \l {overload-command}{\\overload}, \li \l {preliminary-command}{\\preliminary}, \li \l {previouspage-command}{\\previouspage}, + \li \l {qmlabstract-command} {\\qmlabstract} \li \l {reentrant-command}{\\reentrant}, \li \l {reimp-command}{\\reimp}, \li \l {relates-command}{\\relates}, @@ -199,21 +201,41 @@ index page of the collection. */ - /*! \page 16-qdoc-commands-status.html \previouspage Document Navigation \contentspage QDoc Manual \nextpage Thread Support - \title Reporting Status - - These commands are for indicating that a documented element is - still under development, is becoming obsolete, is provided for - compatibility reasons, or is simply not to be included in the - public interface. The \l {since-command}{\\since} command is for - including information about the version when a function or class - first appeared. + \title Status + + These commands are for indicating that a documented element has + some special status. The element could be marked as about to be + made obsolete, or that it is provided for compatibility with an + earlier version, or is simply not to be included in the public + interface. The \l {since-command}{\\since} command is for + specifying the version number in which a function or class first + appeared. The \l {qmlabstract-command} {\\qmlabstract} command is + for marking a QML type as an abstract base class. + + \target abstract-command + \target qmlabstract-command + \section1 \\abstract and \\qmlabstract + + \\abstract is a synonym for the \\qmlabstract command. Add this + command to the \l {qmltype-command} {\\qmltype} comment for a QML + type when that type is meant to be used \e {only} as an abstract + base type. When a QML type is abstract, it means that the QML type + that can't be instantiated. Instead, the properties in its public + API are included in the public properties list on the reference + page for each QML type that inherits the abstract QML type. The + properties are documented as if they are properties of the + inheriting QML type. + + Normally, when a QML type is marked with \e{\\qmlabstract}, it is + also marked with \e{\\internal} so that its reference page is not + generated. It the abstract QML type is not marked internal, it + will have a reference page in the documentation. \target compat-command \section1 \\compat @@ -412,13 +434,14 @@ / *! \preliminary - Returns information about the joining properties of the - character (needed for certain languages such as - Arabic). + Returns information about the joining type attributes of the + character (needed for certain languages such as Arabic or + Syriac). + * / - QChar::Joining QChar::joining() const + QChar::JoiningType QChar::joiningType() const { - return ::joining(*this); + return QChar::joiningType(ucs); } \endcode @@ -427,28 +450,25 @@ \quotation \raw HTML <h3> - <a href="http://doc.qt.io/qt-5/qchar.html#JoiningType-enum">Joining</a> - QChar::joining () const</h3> + <a href="http://doc.qt.io/qt-5/qchar.html#JoiningType-enum">JoiningType</a> + QChar::joiningType() const</h3> \endraw \b {This function is under development and subject to change.} - Returns information about the joining properties of the - character (needed for certain languages such as - Arabic). + Returns information about the joining type attributes of the + character (needed for certain languages such as Arabic or + Syriac). \endquotation - And the function's entry in QChar's list of functions will be + And the function's entry in QChar's list of public functions will be rendered as: \quotation \list \li ... - \li Joining - \l {Joining-enum} - {joining}() - const \c (preliminary) + \li JoiningType \l {QChar::joiningType()} {joiningType}() const \c (preliminary) \li ... \endlist \endquotation @@ -791,7 +811,7 @@ </h3> \endraw - This function overloads \l {addAction} {addAction()} + This function overloads \l {QMenu::addAction()} {addAction()} This convenience function creates a new action with an \e icon and some \e text. The function adds the newly @@ -799,8 +819,7 @@ returns it. See also - \l {addAction} - {QWidget::addAction}(). + \l {QWidget::addAction()} {QWidget::addAction}(). \endquotation If you don't include the function name with the \b{\\overload} diff --git a/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc b/src/tools/qdoc/doc/qdoc-manual-markupcmds.qdoc index d764cde89d..fc576157f7 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)} @@ -2886,19 +2885,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 |