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

Doc: Add \relates command to documented global functions 

qmlRegisterModuleImport() and qmlUnregisterModuleImport() are public,
documented global functions but not related to anything. Associate
them with QQmlEngine make them appear as related non-members.

Same for the related QQmlModuleImportSpecialVersions enum.

Drop the QDoc comment tag (/*!) for an internal function.

Pick-to: 6.4 6.3
Task-number: QTBUG-99578
Change-Id: I3fa81ff12a2c19e6ed09da6a8398e8d1df141b32
Reviewed-by: Luca Di Sera <luca.disera@qt.io>
This commit is contained in:
Topi Reinio 2022-03-23 22:51:09 +01:00
parent ffecd90afa
commit 281c5bf815
2 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/qml/qml/qqml.cpp
View File

@ -212,6 +212,7 @@ static QTypeRevision resolveModuleVersion(int moduleMajor)
/*!
* \enum QQmlModuleImportSpecialVersions
* \relates QQmlEngine
*
* Defines some special values that can be passed to the version arguments of
* qmlRegisterModuleImport() and qmlUnregisterModuleImport().
@ -230,25 +231,26 @@ static QTypeRevision resolveModuleVersion(int moduleMajor)
*/
/*!
* Registers an implicit import for module \a uri of major version \a majorVersion.
* \relates QQmlEngine
* Registers an implicit import for module \a uri of major version \a moduleMajor.
*
* This has the same effect as an \c import statement in a qmldir file: Whenever
* \a uri of version \a moduleMajor is imported, \a import of version
* \a importMajor. \a importMinor is automatically imported, too. If
* \a importMajor is \l QmlModuleImportLatest the latest version
* \a importMajor is \l QQmlModuleImportLatest the latest version
* available of that module is imported, and \a importMinor does not matter. If
* \a importMinor is \l QmlModuleImportLatest the latest minor version of a
* \a importMajor is chosen. If \a importMajor is \l QmlModuleImportAuto the
* \a importMinor is \l QQmlModuleImportLatest the latest minor version of a
* \a importMajor is chosen. If \a importMajor is \l QQmlModuleImportAuto the
* version of \a import is version of \a uri being imported, and \a importMinor
* does not matter. If \a moduleMajor is \a QmlModuleImportModuleAny the module
* does not matter. If \a moduleMajor is \l QQmlModuleImportModuleAny the module
* import is applied for any major version of \a uri. For example, you may
* specify that whenever any version of MyModule is imported, the latest version
* of MyOtherModule should be imported. Then, the following call would be
* appropriate:
*
* \code
* qmlRegisterModuleImport("MyModule", QmlModuleImportModuleAny,
* "MyOtherModule", QmlModuleImportLatest);
* qmlRegisterModuleImport("MyModule", QQmlModuleImportModuleAny,
* "MyOtherModule", QQmlModuleImportLatest);
* \endcode
*
* Or, you may specify that whenever major version 5 of "MyModule" is imported,
@ -262,8 +264,8 @@ static QTypeRevision resolveModuleVersion(int moduleMajor)
* imported whenever "MyModule" is imported, specify the following:
*
* \code
* qmlRegisterModuleImport("MyModule", QmlModuleImportModuleAny,
* "MyOtherModule", QmlModuleImportAuto);
* qmlRegisterModuleImport("MyModule", QQmlModuleImportModuleAny,
* "MyOtherModule", QQmlModuleImportAuto);
* \endcode
*
* \sa qmlUnregisterModuleImport()
@ -278,6 +280,7 @@ void qmlRegisterModuleImport(const char *uri, int moduleMajor,
/*!
* \relates QQmlEngine
* Removes a module import previously registered with qmlRegisterModuleImport()
*
* Calling this function makes sure that \a import of version

2
src/qml/qmldirparser/qqmlimportresolver.cpp
View File

@ -7,7 +7,7 @@ QT_BEGIN_NAMESPACE
enum ImportVersion { FullyVersioned, PartiallyVersioned, Unversioned };
/*!
/*
Forms complete paths to a module, from a list of base paths,
a module URI and version specification.