qiurui
/
qtdeclarative
mirror of https://github.com/qt/qtdeclarative.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Topi Reinio 2013-09-25 15:09:00 +02:00 committed by The Qt Project
parent 63727e4d38
commit c708848d7c
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/qml/doc/src/qmlfunctions.qdoc
View File

@ -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.
*/