qiurui
/
qtbase
mirror of https://github.com/qt/qtbase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Doc: Make 'Platform Notes' optional in template 

Currently the app-examples-template.qdoc file contains a mandatory
'Platform Notes' section. This section lists the different platforms
that the example can be run on. Since all Qt application examples are
cross-platform, this information is not necessary.

This patch states that the 'Platform Notes' section is optional and
should be used if there are any plaform limitations or exceptions.

Fixes: QTBUG-139286
Pick-to: 6.10
Change-Id: Iad10b1cc5a5ca4880e92327d1ffd77b61988e72d
Reviewed-by: Andreas Eliasson <andreas.eliasson@qt.io>
This commit is contained in:
Safiyyah Moosa 2025-08-19 14:15:57 +02:00
parent ca13c01f85
commit ed4b88e68c
2 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/global/app-examples-template/README.md
View File

@ -32,10 +32,9 @@ angle brackets and check the links.
- Include the [Launching Examples Template](https://github.com/qt/qtbase/blob/dev/doc/global/includes/examples-run.qdocinc).
- Explain the expected application output after running the example.
### Provide relevant platform information
### (Optional) Provide relevant platform information
- Mention limitations of target platforms, if there are any.
- Mention which platforms the example can be used on.
- List any platform limitations or exceptions, if applicable.
### (Optional) Provide a UI walkthrough
@ -65,6 +64,10 @@ angle brackets and check the links.
- Explain the implementation of the feature in the code.
### (Optional) Include squish testing information if applicable
- If example was tested with squish, include squish-tested-example.qdocinc
### (Optional) Create a Best practices section
- Add any relevant best practices.

6
doc/global/app-examples-template/app-examples-template.qdoc
View File

@ -21,8 +21,7 @@
<Describe the expected application behavior after running the example.>
\section1 Platform notes
<Mention which platforms the example is for.
Mention limitations of target platforms, if any.>
<Optional - Mention limitations of target platforms, if any.>
\section1 UI walkthrough
<Optional - Use this section for more complicated examples.>
@ -53,6 +52,9 @@
<Include best practices related to the example if applicable.>
<Optional - use this section if the example was tested with squish>
\include squish-tested-example.qdocinc
\section1 Source files
\sa {All Qt Examples}, <Link to other relevant docs.>