Doc: Fix documentation warnings
* Remove \generatelist example[files|images] commands, they do not produce any output, only warnings. * Add missing full stop to \brief descriptions. Pick-to: 6.5 Change-Id: I90c67b8c3f3bbe901fa083f781e9056da7763671 Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
parent
65636e6478
commit
9c8a63b6c0
|
@ -4,7 +4,7 @@
|
|||
\title Qt Quick Examples - Embedded in Widgets
|
||||
\example embeddedinwidgets
|
||||
\image qml-embeddedinwidgets-example.jpg
|
||||
\brief Demonstrates embedding a QQuickWindow into a QWidget UI via QWidget::createWindowContainer()
|
||||
\brief Demonstrates embedding a QQuickWindow into a QWidget UI via QWidget::createWindowContainer().
|
||||
\ingroup qtquickexamples
|
||||
|
||||
This example demonstrates one of the approaches to adding Qt Quick content
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
\title Qt Quick Examples - MultiEffect Item Switcher
|
||||
\example multieffect/itemswitcher
|
||||
\image qml-multieffectitemswitcher-example.jpg
|
||||
\brief Demonstrates using MultiEffect
|
||||
\brief Demonstrates MultiEffect usage.
|
||||
\ingroup qtquickexamples
|
||||
|
||||
This example demonstrates advanced usage of the MultiEffect type, which
|
||||
|
|
|
@ -4,7 +4,7 @@
|
|||
\title Qt Quick Examples - MultiEffect Test Bed
|
||||
\example multieffect/testbed
|
||||
\image qml-multieffecttestbed-example.jpg
|
||||
\brief Demonstrates using MultiEffect
|
||||
\brief Demonstrates MultiEffect usage.
|
||||
\ingroup qtquickexamples
|
||||
|
||||
This example demonstrates the MultiEffect type, which offers a simple,
|
||||
|
|
|
@ -195,9 +195,6 @@ Now we can build and run the application:
|
|||
|
||||
\borderedimage qtquickcontrols-chattutorial-chapter1.png
|
||||
|
||||
\noautolist
|
||||
\generatelist examplefiles .*chapter1.*
|
||||
|
||||
\section1 Chapter 2: Lists
|
||||
|
||||
In this chapter, we'll explain how to create a list of interactive items using
|
||||
|
@ -272,8 +269,6 @@ vertical space.
|
|||
|
||||
\borderedimage qtquickcontrols-chattutorial-chapter2.png
|
||||
|
||||
\generatelist examplefiles .*(chapter2|shared).*
|
||||
\generatelist exampleimages .*shared.*(Einstein|Hemingway|Gude)\.png
|
||||
|
||||
\section1 Chapter 3: Navigation
|
||||
|
||||
|
@ -499,8 +494,6 @@ Finally, the button is only enabled when there is actually a message to send.
|
|||
|
||||
\borderedimage qtquickcontrols-chattutorial-chapter3.gif
|
||||
|
||||
\generatelist examplefiles .*(chapter3|shared).*
|
||||
\generatelist exampleimages .*shared.*(Einstein|Hemingway|Gude)\.png
|
||||
|
||||
\section1 Chapter 4: Models
|
||||
|
||||
|
@ -718,8 +711,6 @@ text field to make way for future input.
|
|||
|
||||
\borderedimage qtquickcontrols-chattutorial-chapter4.gif
|
||||
|
||||
\generatelist examplefiles .*(chapter4|shared).*
|
||||
\generatelist exampleimages
|
||||
|
||||
\section1 Chapter 5: Styling
|
||||
|
||||
|
@ -848,8 +839,6 @@ After building and running the application, you should see these results:
|
|||
\borderedimage qtquickcontrols-chattutorial-chapter5-contacts-universal-dark.png
|
||||
\borderedimage qtquickcontrols-chattutorial-chapter5-conversations-universal-dark.png
|
||||
|
||||
\generatelist examplefiles .*(chapter5|shared).*
|
||||
\generatelist exampleimages
|
||||
|
||||
\section1 Summary
|
||||
|
||||
|
|
|
@ -162,10 +162,6 @@ Now we can build and run the application:
|
|||
cannot update the binding if the \c name value changes. This is addressed in
|
||||
the following chapters.
|
||||
|
||||
The source code from the following files are referred to in this chapter:
|
||||
\noautolist
|
||||
\generatelist examplefiles .*chapter1.*
|
||||
|
||||
\section1 Chapter 2: Connecting to C++ Methods and Signals
|
||||
\c extending-qml/chapter2-methods
|
||||
|
||||
|
@ -205,8 +201,6 @@ disappears, and the application outputs:
|
|||
qml: The chart has been cleared
|
||||
\endcode
|
||||
|
||||
The source code from the following files are referred to in this chapter:
|
||||
\generatelist examplefiles .*chapter2.*
|
||||
|
||||
\section1 Chapter 3: Adding Property Bindings
|
||||
\c extending-qml/chapter3-bindings
|
||||
|
@ -256,8 +250,6 @@ automatically updated and cannot be used as flexibly in QML. Also, since
|
|||
bindings are invoked so often and relied upon in QML usage, users of your
|
||||
custom QML types may see unexpected behavior if bindings are not implemented.
|
||||
|
||||
The source code from the following files are referred to in this chapter:
|
||||
\generatelist examplefiles .*chapter3.*
|
||||
|
||||
\section1 Chapter 4: Using Custom Property Types
|
||||
|
||||
|
@ -346,8 +338,6 @@ Using CMake:
|
|||
\snippet tutorials/extending-qml/chapter4-customPropertyTypes/CMakeLists.txt 1
|
||||
\dots
|
||||
|
||||
The source code from the following files are referred to in this chapter:
|
||||
\generatelist examplefiles .*chapter4.*
|
||||
|
||||
\section1 Chapter 5: Using List Property Types
|
||||
\c extending-qml/chapter5-listproperties
|
||||
|
@ -391,8 +381,6 @@ The \c PieSlice class has also been modified to include \c fromAngle and \c angl
|
|||
properties and to draw the slice according to these values. This is a straightforward
|
||||
modification if you have read the previous pages in this tutorial, so the code is not shown here.
|
||||
|
||||
The source code from the following files are referred to in this chapter:
|
||||
\generatelist examplefiles .*chapter5.*
|
||||
|
||||
\section1 Chapter 6: Writing an Extension Plugin
|
||||
|
||||
|
@ -467,8 +455,6 @@ setting the import path to the current directory so that it finds the \c qmldir
|
|||
The module "Charts" will be loaded by the QML engine, and the types provided by that
|
||||
module will be available for use in any QML document which imports it.
|
||||
|
||||
The source code from the following files are referred to in this chapter:
|
||||
\generatelist examplefiles .*chapter6.*
|
||||
|
||||
\section1 Chapter 7: Summary
|
||||
|
||||
|
|
Loading…
Reference in New Issue