From ece79ecd0ae553ec66bb40a61c00507e466bc5e6 Mon Sep 17 00:00:00 2001 From: Chris Adams Date: Mon, 2 Jul 2012 17:21:45 +1000 Subject: [PATCH] Fix qmlRegisterModuleApi function linkage The qdoc tag for the \fn doc was incorrect, leading to linkage errors. Task-number: QTBUG-26236 Change-Id: Ifd407915d9a1461bb2b48a6bf54bb085425ba76b Reviewed-by: Bea Lam --- src/qml/doc/src/cppintegration/functions.qdoc | 5 +++-- src/qml/doc/src/cppintegration/registercpptypes.qdoc | 2 +- src/qml/doc/src/qmlfunctions.qdoc | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/src/qml/doc/src/cppintegration/functions.qdoc b/src/qml/doc/src/cppintegration/functions.qdoc index 10a9434..d32dd77 100644 --- a/src/qml/doc/src/cppintegration/functions.qdoc +++ b/src/qml/doc/src/cppintegration/functions.qdoc @@ -200,8 +200,9 @@ QML is by registering a QObject module API. This allows functionality and data to be exposed in a namespace which is accessible from QML. See the documentation about \l{Defining QML Object Types from C++#Module-API-Type-Registration} -for information about module APIs, and see the \l{qmlRegisterModuleApi()} -documentation for details on how to register and use a module API. +{Module API type registration} for information about module APIs, +and see the \l{qmlRegisterModuleApi()} documentation for details on how to +register and use a module API. A module API is instantiated and owned by the engine as a singleton. Thus, it is more performant to implement common functionality in a module diff --git a/src/qml/doc/src/cppintegration/registercpptypes.qdoc b/src/qml/doc/src/cppintegration/registercpptypes.qdoc index 5020b68..fc11cfc 100644 --- a/src/qml/doc/src/cppintegration/registercpptypes.qdoc +++ b/src/qml/doc/src/cppintegration/registercpptypes.qdoc @@ -225,7 +225,7 @@ int qmlRegisterType(const char *uri, int versionMajor, int versionMinor, const c A QJSValue may also be exposed as a module API, however clients should be aware that properties of such a module API cannot be bound to. - See \l{qmlRegisterModuleApi()} for more information on how implement and + See \l{qmlRegisterModuleApi()} for more information on how implement and register a new module API, and how to use an existing module API. \section1 Type Revisions and Versions diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc index 974d99c..e8f6e5f 100644 --- a/src/qml/doc/src/qmlfunctions.qdoc +++ b/src/qml/doc/src/qmlfunctions.qdoc @@ -251,7 +251,7 @@ */ /*! - \fn template int qmlRegisterModuleApi(const char *uri, int versionMajor, int versionMinor, QObject *(*callback)(QQmlEngine *, QJSEngine *)) + \fn int qmlRegisterModuleApi(const char *uri, int versionMajor, int versionMinor, QObject *(*callback)(QQmlEngine *, QJSEngine *)) \relates QQmlEngine This function may be used to register a module API provider \a callback in a particular \a uri -- 2.7.4