diff options
| author | Topi Reinio <topi.reinio@digia.com> | 2013-09-25 15:09:00 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-09-25 16:16:15 +0200 |
| commit | c708848d7cf7dd2dfff805c45dec85408fd151f4 (patch) | |
| tree | fc4233dbb4c6a50ec4d86f8f1c26559d3bbcbaf4 /src/qml/doc | |
| parent | 63727e4d385a02d15442f4c6c42439f16e2cc193 (diff) | |
Doc: Fix documentation of qmlProtectModule
Fix the function signature used in \fn command and
document the parameters.
Change-Id: Ieda9b2b402886b81691195dbad17663fd454f282
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/qml/doc')
| -rw-r--r-- | src/qml/doc/src/qmlfunctions.qdoc | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc index 7d668a4a11..b4b8fce162 100644 --- a/src/qml/doc/src/qmlfunctions.qdoc +++ b/src/qml/doc/src/qmlfunctions.qdoc @@ -414,7 +414,7 @@ */ /*! - \fn int qmlProtectModule(const QString &uri, int versionMajor); + \fn bool qmlProtectModule(const char* uri, int majVersion); \relates QQmlEngine This function protects a module from having types registered into it. This @@ -434,7 +434,9 @@ #include <QtQml> to use this function. - Returns true if the module was found and locked, otherwise returns false. - The module must contain exported types in order to be found. + Returns true if the module with \a uri as a \l{Identified Modules} + {module identifier} and \a majVersion as a major version number was found + and locked, otherwise returns false. The module must contain exported types + in order to be found. */ |