diff options
author | Paul Wicking <paul.wicking@qt.io> | 2018-12-19 17:42:43 +0100 |
---|---|---|
committer | Paul Wicking <paul.wicking@qt.io> | 2018-12-23 13:31:36 +0000 |
commit | 81da7d4bea0289501f0365d15b7b1229c43e6a10 (patch) | |
tree | 13d4f0b38f56aaae754c08fa7bf99e06a696245d | |
parent | 446038b9a8b5a2f9b573cbb37be041acd6c93ceb (diff) | |
download | qttools-81da7d4bea0289501f0365d15b7b1229c43e6a10.tar.gz |
Move QML documentation example to QDoc tests
The import and types contained in the example ends up in reference
overviews. This causes confusion among users. The example serves its
purpose better as a QML project to generate documentation from as tests
for QDoc.
Moving the example to tests/auto/qdoc will exclude it from ending up in
the online docs. This will also keep the git history cleaner than
readding the same files as a separate commit later on.
Task-number: QTBUG-43904
Change-Id: I6e080d50319f235916cbd8e1dda3da7dba1dccd1
Reviewed-by: Kai Koehne <kai.koehne@qt.io>
Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
-rw-r--r-- | src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc | 2 | ||||
-rw-r--r-- | tests/auto/qdoc/qmlcomponentoutput/componentset/ProgressBar.qml (renamed from src/qdoc/doc/examples/componentset/ProgressBar.qml) | 0 | ||||
-rw-r--r-- | tests/auto/qdoc/qmlcomponentoutput/componentset/Switch.qml (renamed from src/qdoc/doc/examples/componentset/Switch.qml) | 0 | ||||
-rw-r--r-- | tests/auto/qdoc/qmlcomponentoutput/componentset/TabWidget.qml (renamed from src/qdoc/doc/examples/componentset/TabWidget.qml) | 0 | ||||
-rw-r--r-- | tests/auto/qdoc/qmlcomponentoutput/componentset/componentset.pro (renamed from src/qdoc/doc/examples/componentset/componentset.pro) | 0 | ||||
-rw-r--r-- | tests/auto/qdoc/qmlcomponentoutput/componentset/uicomponents.qdoc.sample (renamed from src/qdoc/doc/examples/componentset/uicomponents.qdoc.sample) | 0 | ||||
-rw-r--r-- | tests/auto/qdoc/qmlcomponentoutput/examples.qdoc (renamed from src/qdoc/doc/examples/examples.qdoc) | 0 |
7 files changed, 0 insertions, 2 deletions
diff --git a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc index 7d006ada0..7f355b2fe 100644 --- a/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc +++ b/src/qdoc/doc/qdoc-guide/qdoc-guide.qdoc @@ -68,7 +68,6 @@ \li \l{C++ Documentation Style} \li \l{QML Documentation Style} \endlist - \li \l{QML Documentation Example} \endlist */ @@ -397,7 +396,6 @@ \page qdoc-categories.html \title Categories of Documentation \previouspage Writing Documentation - \nextpage QML Documentation Example \brief Describes the different types such as How-To's, Tutorials, Overviews, Examples, and Class Documentation. diff --git a/src/qdoc/doc/examples/componentset/ProgressBar.qml b/tests/auto/qdoc/qmlcomponentoutput/componentset/ProgressBar.qml index 2a40cc488..2a40cc488 100644 --- a/src/qdoc/doc/examples/componentset/ProgressBar.qml +++ b/tests/auto/qdoc/qmlcomponentoutput/componentset/ProgressBar.qml diff --git a/src/qdoc/doc/examples/componentset/Switch.qml b/tests/auto/qdoc/qmlcomponentoutput/componentset/Switch.qml index db9616b69..db9616b69 100644 --- a/src/qdoc/doc/examples/componentset/Switch.qml +++ b/tests/auto/qdoc/qmlcomponentoutput/componentset/Switch.qml diff --git a/src/qdoc/doc/examples/componentset/TabWidget.qml b/tests/auto/qdoc/qmlcomponentoutput/componentset/TabWidget.qml index 07fd40db9..07fd40db9 100644 --- a/src/qdoc/doc/examples/componentset/TabWidget.qml +++ b/tests/auto/qdoc/qmlcomponentoutput/componentset/TabWidget.qml diff --git a/src/qdoc/doc/examples/componentset/componentset.pro b/tests/auto/qdoc/qmlcomponentoutput/componentset/componentset.pro index 5b44737c2..5b44737c2 100644 --- a/src/qdoc/doc/examples/componentset/componentset.pro +++ b/tests/auto/qdoc/qmlcomponentoutput/componentset/componentset.pro diff --git a/src/qdoc/doc/examples/componentset/uicomponents.qdoc.sample b/tests/auto/qdoc/qmlcomponentoutput/componentset/uicomponents.qdoc.sample index 0c6d187ed..0c6d187ed 100644 --- a/src/qdoc/doc/examples/componentset/uicomponents.qdoc.sample +++ b/tests/auto/qdoc/qmlcomponentoutput/componentset/uicomponents.qdoc.sample diff --git a/src/qdoc/doc/examples/examples.qdoc b/tests/auto/qdoc/qmlcomponentoutput/examples.qdoc index 7c780eca8..7c780eca8 100644 --- a/src/qdoc/doc/examples/examples.qdoc +++ b/tests/auto/qdoc/qmlcomponentoutput/examples.qdoc |