diff options
| author | Paul Wicking <paul.wicking@qt.io> | 2023-05-04 20:09:14 +0200 |
|---|---|---|
| committer | Paul Wicking <paul.wicking@qt.io> | 2023-05-05 09:38:55 +0000 |
| commit | da8244d82e46905186769b591827ba0c8002f2e5 (patch) | |
| tree | 93589ef5206f48a7b8c8db854140f165c96d9453 | |
| parent | e7d67531cc64c7a4d4f0ddd5ae3190dbabd67878 (diff) | |
| download | qttools-da8244d82e46905186769b591827ba0c8002f2e5.tar.gz | |
Doc: Let QDoc manual reflect new example guidelines
The new guidelines for examples in Qt recommend one avoids use of
the word "Example" in an example's name. The QDoc manual contains
documentation for the example manifest files generated by QDoc.
This documentation references content generated with a naming
scheme that doesn't adhere to the new guidelines. This patch
removes the use of the word 'example' from example names such that
example content in the QDoc manual reflects the new example naming
scheme in Qt.
Fixes: QTBUG-113393
Change-Id: Idd95bd06c6b67471aed5cb6147386235ceac79c7
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
| -rw-r--r-- | src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc index f4fe176da..d03f6d601 100644 --- a/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/qdoc/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -1951,10 +1951,10 @@ <instructionals module="QtGui"> <examples> <example - name="Analog Clock Window Example" + name="Analog Clock Window" docUrl="qthelp://org.qt-project.qtgui.502/qtgui/analogclock.html" projectPath="gui/analogclock/analogclock.pro" - imageUrl="qthelp://org.qt-project.qtgui.502/qtgui/images/analogclock-window-example.png"> + imageUrl="qthelp://org.qt-project.qtgui.502/qtgui/images/analogclock-window.png"> <description><![CDATA[The Analog Clock Window example shows how to draw the contents of a custom window.]]></description> <tags>analog,clock,window</tags> @@ -1991,8 +1991,8 @@ \badcode manifestmeta.filters = highlighted sql webkit global - manifestmeta.highlighted.names = "QtGui/Analog Clock Window Example" \ - "QtWidgets/Analog Clock Example" + manifestmeta.highlighted.names = "QtGui/Analog Clock Window" \ + "QtWidgets/Analog Clock" manifestmeta.highlighted.attributes = isHighlighted:true manifestmeta.sql.names = "QtSql/*" @@ -2002,7 +2002,7 @@ manifestmeta.webkit.tags = webkit manifestmeta.global.names = * - manifestmeta.global.tags = qt5 + manifestmeta.global.tags = qt6 \endcode Above, an \c isHighlighted attribute is added to two examples. If |