Skip to content

Commit dc41b6a

Browse files
Documentation: Add missing pages
Add pages referenced from the overviews-main page and various module pages. Do a scan and add all (non-class reference) documents found except qtcore/qtdoc (too many) and deprecated modules. As a drive-by, developer the documentation. Pick-to: 6.8 Change-Id: Ibe16ff70b627274fbbbffeb93030ddea230295a8 Reviewed-by: Shyamnath Premnadh <[email protected]>
1 parent e89255f commit dc41b6a

File tree

2 files changed

+105
-2
lines changed

2 files changed

+105
-2
lines changed

sources/pyside6/doc/additionaldocs.lst

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,13 +87,15 @@ qtdoc/webxml/gettingstarted.webxml
8787
qtdoc/webxml/highdpi.webxml
8888
qtdoc/webxml/install-qt-design-studio.webxml
8989
qtdoc/webxml/known-issues.webxml
90+
qtdoc/webxml/mobiledevelopment.webxml
9091
qtdoc/webxml/overviews-main.webxml
9192
qtdoc/webxml/plugins-howto.webxml
9293
qtdoc/webxml/qmlapplications.webxml
9394
qtdoc/webxml/qml-codingconventions.webxml
9495
qtdoc/webxml/qmlfirststeps.webxml
9596
qtdoc/webxml/qml-glossary.webxml
9697
qtdoc/webxml/qt-intro.webxml
98+
qtdoc/webxml/qtlanguages.webxml
9799
qtdoc/webxml/qtquick-debugging.webxml
98100
qtdoc/webxml/qtquick-performance.webxml
99101
qtdoc/webxml/qtquick-qml-runtime.webxml
@@ -104,24 +106,41 @@ qtdoc/webxml/qtquick-usecase-styling.webxml
104106
qtdoc/webxml/qtquick-usecase-text.webxml
105107
qtdoc/webxml/qtquick-usecase-userinput.webxml
106108
qtdoc/webxml/qtquick-usecase-visual.webxml
109+
qtdoc/webxml/qt-releases.webxml
107110
qtdoc/webxml/qundo.webxml
108111
qtdoc/webxml/rcc.webxml
109112
qtdoc/webxml/restoring-geometry.webxml
110113
qtdoc/webxml/scalability.webxml
114+
qtdoc/webxml/security.webxml
111115
qtdoc/webxml/session.webxml
112116
qtdoc/webxml/sharedlibrary.webxml
113117
qtdoc/webxml/solutions-for-application-development.webxml
114118
qtdoc/webxml/solutions-for-ui-design.webxml
119+
qtdoc/webxml/testing-and-debugging.webxml
115120
qtdoc/webxml/thread-basics.webxml
116121
qtdoc/webxml/threads.webxml
117122
qtdoc/webxml/tools-for-qt-quick-uis.webxml
118123
qtdoc/webxml/tools-for-qt-widget-based-uis.webxml
119124
qtdoc/webxml/topics-app-development.webxml
125+
qtdoc/webxml/topics-core.webxml
120126
qtdoc/webxml/topics-data-io.webxml
127+
qtdoc/webxml/topics-graphics.webxml
128+
qtdoc/webxml/topics-network-connectivity.webxml
121129
qtdoc/webxml/topics-ui.webxml
122130
qtdoc/webxml/uic.webxml
123131
qtdoc/webxml/unicode.webxml
132+
qtdoc/webxml/untrusteddata.webxml
124133
qtdoc/webxml/wayland-and-qt.webxml
134+
qtgraphs/webxml/qtgraphs-and-qtquick3d-integration-guide.webxml
135+
qtgraphs/webxml/qtgraphs-configure-options.webxml
136+
qtgraphs/webxml/qtgraphs-data-handling.webxml
137+
qtgraphs/webxml/qtgraphs-interacting-with-data.webxml
138+
qtgraphs/webxml/qtgraphs-known-issues.webxml
139+
qtgraphs/webxml/qtgraphs-migration-guide-2d.webxml
140+
qtgraphs/webxml/qtgraphs-migration-guide.webxml
141+
qtgraphs/webxml/qtgraphs-overview-2d.webxml
142+
qtgraphs/webxml/qtgraphs-overview-3d.webxml
143+
qtgraphs/webxml/qtgraphs-overview-theme.webxml
125144
qtgui/webxml/coordsys.webxml
126145
qtgui/webxml/dnd.webxml
127146
qtgui/webxml/gui-changes-qt6.webxml
@@ -136,6 +155,7 @@ qtgui/webxml/qiconengine-scaledpixmapargument.webxml
136155
qtgui/webxml/qpageranges-range.webxml
137156
qtgui/webxml/qtextlayout-formatrange.webxml
138157
qtgui/webxml/qtextoption-tab.webxml
158+
qtgui/webxml/qtgui-overview.webxml
139159
qtgui/webxml/richtext-advanced-processing.webxml
140160
qtgui/webxml/richtext-common-tasks.webxml
141161
qtgui/webxml/richtext-cursor.webxml
@@ -147,35 +167,60 @@ qthelp/webxml/helpsystem.webxml
147167
qthelp/webxml/qhelplink.webxml
148168
qthelp/webxml/qthelp-framework.webxml
149169
qthelp/webxml/qthelpproject.webxml
170+
qthttpserver/webxml/qthttpserver-colorpalette-apibehavior-h.webxml
171+
qthttpserver/webxml/qthttpserver-colorpalette-colorpalette-pro.webxml
172+
qthttpserver/webxml/qthttpserver-colorpalette-main-cpp.webxml
173+
qthttpserver/webxml/qthttpserver-colorpalette-types-h.webxml
174+
qthttpserver/webxml/qthttpserver-colorpalette-utils-h.webxml
175+
qthttpserver/webxml/qthttpserver-logging.webxml
176+
qtlocation/webxml/location-places-backend.webxml
177+
qtlocation/webxml/location-plugin-itemsoverlay.webxml
178+
qtlocation/webxml/location-plugin-osm.webxml
179+
qtlocation/webxml/qml-location5-maps.webxml
180+
qtlocation/webxml/qtlocation-geoservices.webxml
181+
qtmultimedia/webxml/advanced-ffmpeg-configuration.webxml
150182
qtmultimedia/webxml/audiooverview.webxml
151183
qtmultimedia/webxml/cameraoverview.webxml
152184
qtmultimedia/webxml/multimediaoverview.webxml
153185
qtmultimedia/webxml/qmediatimerange-interval.webxml
186+
qtmultimedia/webxml/qt-add-ios-ffmpeg-libraries.webxml
154187
qtmultimedia/webxml/qtmultimedia-apple.webxml
155188
qtmultimedia/webxml/qtmultimedia-changes-qt6.webxml
189+
qtmultimedia/webxml/qtmultimedia-gstreamer.webxml
190+
qtmultimedia/webxml/qtmultimedia-modules.webxml
191+
qtmultimedia/webxml/qtmultimedia-wayland.webxml
192+
qtmultimedia/webxml/qtmultimedia-windows.webxml
156193
qtmultimedia/webxml/videooverview.webxml
194+
qtnetworkauth/webxml/oauth-http-method-alternatives.webxml
157195
qtnetwork/webxml/network-changes-qt6.webxml
158196
qtnetwork/webxml/qdtlsclientverifier-generatorparameters.webxml
159197
qtnetwork/webxml/qtnetwork-programming.webxml
160198
qtnetwork/webxml/ssl.webxml
161199
qtnfc/webxml/nfc-android.webxml
162200
qtnfc/webxml/qndeffilter-record.webxml
163201
qtnfc/webxml/qtnfc-changes-qt6.webxml
202+
qtnfc/webxml/qtnfc-features.webxml
164203
qtnfc/webxml/qtnfc-overview.webxml
204+
qtnfc/webxml/qtnfc-pcsc.webxml
165205
qtopengl/webxml/opengl-changes-qt6.webxml
166206
qtpositioning/webxml/positioning-cpp-qml.webxml
207+
qtpositioning/webxml/position-plugin-android.webxml
167208
qtpositioning/webxml/position-plugin-geoclue2.webxml
168209
qtpositioning/webxml/position-plugin-gypsy.webxml
169210
qtpositioning/webxml/position-plugin-nmea.webxml
170211
qtpositioning/webxml/qtpositioning-android.webxml
171212
qtpositioning/webxml/qtpositioning-changes-qt6.webxml
172213
qtpositioning/webxml/qtpositioning-ios.webxml
173214
qtpositioning/webxml/qtpositioning-plugins.webxml
215+
qtprintsupport/webxml/pdf-licensing.webxml
174216
qtprintsupport/webxml/printsupport-changes-qt6.webxml
175217
qtqml/webxml/qml-changes-qt6.webxml
176218
qtqml/webxml/qmldiskcache.webxml
177219
qtqml/webxml/qmlreference.webxml
220+
qtqml/webxml/qml-singleton.webxml
178221
qtqml/webxml/qqmlcontext-propertypair.webxml
222+
qtqml/webxml/qt-add-qml-plugin.webxml
223+
qtqml/webxml/qt-import-qml-plugins.webxml
179224
qtqml/webxml/qtjavascript.webxml
180225
qtqml/webxml/qtqml-documents-definetypes.webxml
181226
qtqml/webxml/qtqml-documents-networktransparency.webxml
@@ -188,17 +233,56 @@ qtqml/webxml/qtqml-javascript-finetuning.webxml
188233
qtqml/webxml/qtqml-javascript-functionlist.webxml
189234
qtqml/webxml/qtqml-javascript-hostenvironment.webxml
190235
qtqml/webxml/qtqml-javascript-imports.webxml
236+
qtqml/webxml/qtqml-javascript-memory.webxml
191237
qtqml/webxml/qtqml-javascript-qmlglobalobject.webxml
192238
qtqml/webxml/qtqml-javascript-resources.webxml
193239
qtqml/webxml/qtqml-javascript-topic.webxml
240+
qtqml/webxml/qtqml-modules-identifiedmodules.webxml
241+
qtqml/webxml/qtqml-modules-legacymodules.webxml
242+
qtqml/webxml/qtqml-modules-qmldir.webxml
243+
qtqml/webxml/qtqml-modules-topic.webxml
194244
qtqml/webxml/qtqml-syntax-basics.webxml
195245
qtqml/webxml/qtqml-syntax-directoryimports.webxml
196246
qtqml/webxml/qtqml-syntax-imports.webxml
197247
qtqml/webxml/qtqml-syntax-objectattributes.webxml
198248
qtqml/webxml/qtqml-syntax-propertybinding.webxml
249+
qtqml/webxml/qtqml-syntax-signals.webxml
199250
qtqml/webxml/qtqml-typesystem-basictypes.webxml
251+
qtqml/webxml/qtqml-typesystem-namespaces.webxml
200252
qtqml/webxml/qtqml-typesystem-objecttypes.webxml
253+
qtqml/webxml/qtqml-typesystem-references.webxml
254+
qtqml/webxml/qtqml-typesystem-sequencetypes.webxml
201255
qtqml/webxml/qtqml-typesystem-topic.webxml
256+
qtqml/webxml/qtqml-typesystem-valuetypes.webxml
257+
qtqml/webxml/qt-target-qml-sources.webxml
258+
qtquick3d/webxml/qt3dxr-multiview.webxml
259+
qtquick3d/webxml/qt3dxr-pcvr.webxml
260+
qtquick3d/webxml/qt3dxr-quest-quick-start.webxml
261+
qtquick3d/webxml/qt3dxr-quick-start-guide-applevisionpro.webxml
262+
qtquick3d/webxml/qt3dxr-supported-openxr-extensions.webxml
263+
qtquick3d/webxml/qt3dxr-supported-platforms.webxml
264+
qtquick3d/webxml/qtaa-toc.webxml
265+
qtquick3d/webxml/qtquick3d-2d.webxml
266+
qtquick3d/webxml/qtquick3d-architecture.webxml
267+
qtquick3d/webxml/qtquick3d-custom.webxml
268+
qtquick3d/webxml/qtquick3d-lod.webxml
269+
qtquick3d/webxml/qtquick3d-requirements.webxml
270+
qtquick3d/webxml/qt-quick-3d-xr.webxml
271+
qtquick3d/webxml/qtxr-locomotion.webxml
272+
qtquick3d/webxml/quick3d-asset-conditioning-3d-assets.webxml
273+
qtquick3d/webxml/quick3d-asset-conditioning-anti-aliasing.webxml
274+
qtquick3d/webxml/quick3d-asset-conditioning-export-blender.webxml
275+
qtquick3d/webxml/quick3d-asset-conditioning-export-max.webxml
276+
qtquick3d/webxml/quick3d-asset-conditioning-export-maya.webxml
277+
qtquick3d/webxml/quick3d-asset-conditioning-export-modo.webxml
278+
qtquick3d/webxml/quick3d-asset-conditioning-ibl.webxml
279+
qtquick3d/webxml/quick3d-asset-intro.webxml
280+
qtquick3d/webxml/quick3d-instancing.webxml
281+
qtquick3d/webxml/quick3d-lightmap.webxml
282+
qtquick3d/webxml/quick3d-morphing.webxml
283+
qtquick3d/webxml/quick3d-pbr.webxml
284+
qtquick3d/webxml/quick3d-shadow-mapping.webxml
285+
qtquick3d/webxml/quick3d-vertex-skinning.webxml
202286
qtquickcontrols/webxml/qtquickcontrols-basic.webxml
203287
qtquickcontrols/webxml/qtquickcontrols-buttons.webxml
204288
qtquickcontrols/webxml/qtquickcontrols-changes-qt6.webxml
@@ -209,6 +293,7 @@ qtquickcontrols/webxml/qtquickcontrols-delegates.webxml
209293
qtquickcontrols/webxml/qtquickcontrols-deployment.webxml
210294
qtquickcontrols/webxml/qtquickcontrols-environment.webxml
211295
qtquickcontrols/webxml/qtquickcontrols-fileselectors.webxml
296+
qtquickcontrols/webxml/qtquickcontrols-fluentwinui3.webxml
212297
qtquickcontrols/webxml/qtquickcontrols-focus.webxml
213298
qtquickcontrols/webxml/qtquickcontrols-fusion.webxml
214299
qtquickcontrols/webxml/qtquickcontrols-gettingstarted.webxml
@@ -217,6 +302,7 @@ qtquickcontrols/webxml/qtquickcontrols-icons.webxml
217302
qtquickcontrols/webxml/qtquickcontrols-imagine.webxml
218303
qtquickcontrols/webxml/qtquickcontrols-indicators.webxml
219304
qtquickcontrols/webxml/qtquickcontrols-input.webxml
305+
qtquickcontrols/webxml/qtquickcontrols-ios.webxml
220306
qtquickcontrols/webxml/qtquickcontrols-macos.webxml
221307
qtquickcontrols/webxml/qtquickcontrols-material.webxml
222308
qtquickcontrols/webxml/qtquickcontrols-menus.webxml
@@ -239,6 +325,7 @@ qtquick/webxml/qsggeometry-point2d.webxml
239325
qtquick/webxml/qsggeometry-texturedpoint2d.webxml
240326
qtquick/webxml/qsgmaterialshader-graphicspipelinestate.webxml
241327
qtquick/webxml/qsgmaterialtype.webxml
328+
qtquick/webxml/qtquick-android-classes.webxml
242329
qtquick/webxml/qtquick-bestpractices.webxml
243330
qtquick/webxml/qtquick-codesamples.webxml
244331
qtquick/webxml/qtquick-convenience-topic.webxml
@@ -253,6 +340,7 @@ qtquick/webxml/qtquick-input-mouseevents.webxml
253340
qtquick/webxml/qtquick-input-textinput.webxml
254341
qtquick/webxml/qtquick-input-topic.webxml
255342
qtquick/webxml/qtquicklayouts-overview.webxml
343+
qtquick/webxml/qtquicklayouts-responsive.webxml
256344
qtquick/webxml/qtquick-modelviewsdata-cppmodels.webxml
257345
qtquick/webxml/qtquick-modelviewsdata-modelview.webxml
258346
qtquick/webxml/qtquick-modelviewsdata-topic.webxml
@@ -266,6 +354,7 @@ qtquick/webxml/qtquick-statesanimations-behaviors.webxml
266354
qtquick/webxml/qtquick-statesanimations-states.webxml
267355
qtquick/webxml/qtquick-statesanimations-topic.webxml
268356
qtquick/webxml/qtquick-tools-and-utilities.webxml
357+
qtquick/webxml/qtquickview-android-class.webxml
269358
qtquick/webxml/qtquick-visualcanvas-adaptations-openvg.webxml
270359
qtquick/webxml/qtquick-visualcanvas-adaptations-software.webxml
271360
qtquick/webxml/qtquick-visualcanvas-adaptations.webxml
@@ -306,9 +395,20 @@ qtsensors/webxml/genericbackend.webxml
306395
qtsensors/webxml/qoutputrange.webxml
307396
qtsensors/webxml/qtsensors-changes-qt6.webxml
308397
qtsensors/webxml/qtsensors-cpp.webxml
398+
qtsensors/webxml/qtsensors-tutorial.webxml
309399
qtsensors/webxml/senorfwbackend.webxml
310400
qtsensors/webxml/sensors-backend-topics.webxml
401+
qtserialbus/webxml/qtcanbus-backends.webxml
402+
qtserialbus/webxml/qtmodbus-backends.webxml
403+
qtserialbus/webxml/qtserialbus-passthrucan-overview.webxml
404+
qtserialbus/webxml/qtserialbus-peakcan-overview.webxml
405+
qtserialbus/webxml/qtserialbus-socketcan-overview.webxml
406+
qtserialbus/webxml/qtserialbus-systeccan-overview.webxml
407+
qtserialbus/webxml/qtserialbus-tinycan-overview.webxml
408+
qtserialbus/webxml/qtserialbus-vectorcan-overview.webxml
409+
qtserialbus/webxml/qtserialbus-virtualcan-overview.webxml
311410
qtserialport/webxml/qtserialport-changes-qt6.webxml
411+
qtspatialaudio/webxml/spatialaudiooverview.webxml
312412
qtsql/webxml/qtsql-changes-qt6.webxml
313413
qtsql/webxml/sql-connecting.webxml
314414
qtsql/webxml/sql-driver.webxml
@@ -319,12 +419,15 @@ qtsql/webxml/sql-programming.webxml
319419
qtsql/webxml/sql-sqlstatements.webxml
320420
qtsql/webxml/sql-types.webxml
321421
qtsvg/webxml/qtsvg-changes-qt6.webxml
422+
qtsvg/webxml/svgextensions.webxml
322423
qtsvg/webxml/svgrendering.webxml
323424
qttestlib/webxml/qtest-overview.webxml
324425
qttestlib/webxml/qtest-tutorial.webxml
325426
qttestlib/webxml/qttest-best-practices-qdoc.webxml
326427
qttestlib/webxml/qttestlib-tutorial6.webxml
327428
qttestlib/webxml/testlib-changes-qt6.webxml
429+
qttexttospeech/webxml/qttexttospeech-changes-qt6.webxml
430+
qttexttospeech/webxml/qttexttospeech-engines.webxml
328431
qtwebchannel/webxml/qtwebchannel-changes-qt6.webxml
329432
qtwebchannel/webxml/qtwebchannel-javascript.webxml
330433
qtwebengine/webxml/qtwebengine-changes-qt6.webxml

sources/pyside6/doc/developer/documentation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ Pages of examples that exist in Python should be removed.
5353
5454
for F in *.webxml
5555
do
56-
echo "$F" | egrep '(-index)|(-module)|(-qmlmodule)\.webxml$' > /dev/null
56+
echo "$F" | egrep '(-index|example|cmake|private-module|-changes-qt6|-module.web|-qmlmodule.web)' > /dev/null
5757
if [ $? -ne 0 ]
5858
then
5959
if fgrep '<para>' "$F" > /dev/null # Exclude reference only
6060
then
61-
egrep "(<class )|(<namespace )" $F > /dev/null || echo $F
61+
egrep "(<namespace|<class|<struct|<group|<union)" $F > /dev/null || echo $F
6262
fi
6363
fi
6464
done

0 commit comments

Comments
 (0)