From c708848d7cf7dd2dfff805c45dec85408fd151f4 Mon Sep 17 00:00:00 2001 From: Topi Reinio Date: Wed, 25 Sep 2013 15:09:00 +0200 Subject: [PATCH] Doc: Fix documentation of qmlProtectModule Fix the function signature used in \fn command and document the parameters. Change-Id: Ieda9b2b402886b81691195dbad17663fd454f282 Reviewed-by: Jerome Pasion --- src/qml/doc/src/qmlfunctions.qdoc | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc index 7d668a4..b4b8fce 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 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. */ -- 2.7.4