diff options
| author | Topi Reinio <topi.reinio@qt.io> | 2019-07-18 15:18:31 +0200 |
|---|---|---|
| committer | Topi Reinio <topi.reinio@qt.io> | 2019-08-29 13:04:58 +0200 |
| commit | 1dc3f4c24583e14dee3c5fa650a8ac239b953458 (patch) | |
| tree | bae8b90629c3215ec254221388aad85813237b32 /src/qml/doc/src | |
| parent | da04b1d716617fbe4a2d93dc5a51f38dbd03a5b8 (diff) | |
Doc: Fix documentation warnings for qtdeclarative
After recent changes to QDoc, it now correctly warns about missing
documentation for QML method parameters - fix all of these and also
do some minor language editing.
Remove duplicated entries for
- \qmlmodule Qt.labs.qmlmodels
- \group qtjavascript
as they were causing issues.
Change-Id: I55cd670cc8a0cc6427cdb7945dbd7c28ea94f796
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src/qml/doc/src')
| -rw-r--r-- | src/qml/doc/src/cppintegration/extending-tutorial.qdoc | 3 | ||||
| -rw-r--r-- | src/qml/doc/src/javascript/qtjavascript.qdoc | 7 | ||||
| -rw-r--r-- | src/qml/doc/src/javascript/string.qdoc | 4 |
3 files changed, 3 insertions, 11 deletions
diff --git a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc index 26556644d6..43987354ae 100644 --- a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc +++ b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc @@ -407,8 +407,7 @@ located at the same level as the application that uses our new import module. This way, the QML engine will find our module as the default search path for QML imports includes the directory of the application executable. On \macos, the plugin binary is copied to \c Contents/PlugIns in the the application bundle; -this path is set in \l {tutorials/extending-qml/chapter6-plugins/app.pro} -{chapter6-plugins/app.pro}: +this path is set in \c {chapter6-plugins/app.pro}: \quotefromfile tutorials/extending-qml/chapter6-plugins/app.pro \skipto osx diff --git a/src/qml/doc/src/javascript/qtjavascript.qdoc b/src/qml/doc/src/javascript/qtjavascript.qdoc index ad93d9d9ac..aa4dce6a37 100644 --- a/src/qml/doc/src/javascript/qtjavascript.qdoc +++ b/src/qml/doc/src/javascript/qtjavascript.qdoc @@ -26,13 +26,6 @@ ****************************************************************************/ /*! - \group qtjavascript - \title Scripting Classes and Overviews - - \brief Classes for embedding JavaScript in Qt/C++ applications. -*/ - -/*! \page qtjavascript.html \title Making Applications Scriptable \ingroup frameworks-technologies diff --git a/src/qml/doc/src/javascript/string.qdoc b/src/qml/doc/src/javascript/string.qdoc index f896af3378..47922ff17a 100644 --- a/src/qml/doc/src/javascript/string.qdoc +++ b/src/qml/doc/src/javascript/string.qdoc @@ -39,8 +39,8 @@ /*! \qmlmethod string String::arg(value) - Returns a copy of this string with the lowest numbered place marker replaced by value, - i.e., %1, %2, ..., %99. The following example prints "There are 20 items" + Returns a copy of this string with the lowest numbered place marker replaced by \a value, + i.e., %1, %2, ..., %99. The following example prints "There are 20 items": \code var message = "There are %1 items" |