aboutsummaryrefslogtreecommitdiffstats
path: root/src/qml/doc/src
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2020-11-04 12:52:37 +0100
committerTopi Reinio <topi.reinio@qt.io>2020-11-05 09:00:44 +0100
commitc01ad45d67ec0ce96d6944496dc292a94f17efea (patch)
tree537b4b7db2bf2d9be7f55ac8139dddfd06f911b1 /src/qml/doc/src
parent9eea418e1a13e0cee239903103dbccb83e936c40 (diff)
Doc:: Fix documentation warnings for Qt QML
Task-number: QTBUG-88156 Change-Id: Ic6127c6128b4c7736cb4b5ab8ce51629388b59ca Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/qml/doc/src')
-rw-r--r--src/qml/doc/src/cppintegration/extending-tutorial.qdoc11
-rw-r--r--src/qml/doc/src/qmlfunctions.qdoc2
-rw-r--r--src/qml/doc/src/qtqml.qdoc10
3 files changed, 11 insertions, 12 deletions
diff --git a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
index 458768bf18..6e6d067ba6 100644
--- a/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
+++ b/src/qml/doc/src/cppintegration/extending-tutorial.qdoc
@@ -328,7 +328,7 @@ version 1.0 to the .pro file:
\snippet tutorials/extending-qml/chapter4-customPropertyTypes/pieslice.h 0
\dots
-\quotefile tutorials/extending-qml/chapter1-basics/chapter4-customPropertyTypes.pro
+\quotefile tutorials/extending-qml/chapter4-customPropertyTypes/chapter4-customPropertyTypes.pro
The source code from the following files are referred to in this chapter:
\generatelist examplefiles .*chapter4.*
@@ -391,17 +391,14 @@ by any QML application, instead of restricting these types to be only used by
the one application.
The steps for creating a plugin are described in \l {Creating C++ Plugins for QML}.
-To start with, we create a plugin class named \c ChartsPlugin. It subclasses QQmlExtensionPlugin
-and registers our QML types in the inherited \l{QQmlExtensionPlugin::}{registerTypes()} method.
+To start with, we create a plugin class named \c ChartsPlugin. It subclasses
+QQmlEngineExtensionPlugin and uses the Q_PLUGIN_METADATA() macro to register the
+plugin with the Qt meta object system.
Here is the \c ChartsPlugin definition in \c chartsplugin.h:
\snippet tutorials/extending-qml/chapter6-plugins/import/chartsplugin.h 0
-And its implementation in \c chartsplugin.cpp:
-
-\snippet tutorials/extending-qml/chapter6-plugins/import/chartsplugin.cpp 0
-
Then, we write a \c .pro project file that defines the project as a plugin library
and specifies with DESTDIR that library files should be built into a \c {../Charts}
directory.
diff --git a/src/qml/doc/src/qmlfunctions.qdoc b/src/qml/doc/src/qmlfunctions.qdoc
index 82ce7cbf92..f7a84e6584 100644
--- a/src/qml/doc/src/qmlfunctions.qdoc
+++ b/src/qml/doc/src/qmlfunctions.qdoc
@@ -164,7 +164,7 @@
if the type is available in QML, by having a \l QML_ELEMENT or
\l QML_NAMED_ELEMENT() macro. By default, each QQmlEngine will try to create a
singleton instance using either the type's default constructor or a static
- factory function of the signature \a{T *create(QQmlEngine *, QJSEngine *)}
+ factory function of the signature \c{T *create(QQmlEngine *, QJSEngine *)}
when the type is first accessed. If both do exist and are accessible, the
default constructor is preferred. If there is no default constructor and no
factory function the singleton is initially inaccessible. This behavior can be
diff --git a/src/qml/doc/src/qtqml.qdoc b/src/qml/doc/src/qtqml.qdoc
index 5a1b59acdd..9c2ce11aa0 100644
--- a/src/qml/doc/src/qtqml.qdoc
+++ b/src/qml/doc/src/qtqml.qdoc
@@ -134,10 +134,12 @@ the QML code to interact with C++ code.
\li \l{Integrating QML and C++}
\endlist
-\section1 Additional Frameworks
-\list
-\li \l{The Declarative State Machine Framework}
-\endlist
+\omit
+ \section1 Additional Frameworks
+ \list
+ \li \l{The Declarative State Machine Framework}
+ \endlist
+\endomit
\section1 Licenses and Attributions