diff --git a/doc/global/app-examples-template/README.md b/doc/global/app-examples-template/README.md index 066d0fd4d67..05c093db9f3 100644 --- a/doc/global/app-examples-template/README.md +++ b/doc/global/app-examples-template/README.md @@ -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. diff --git a/doc/global/app-examples-template/app-examples-template.qdoc b/doc/global/app-examples-template/app-examples-template.qdoc index 691b03ebda2..ff9f59001db 100644 --- a/doc/global/app-examples-template/app-examples-template.qdoc +++ b/doc/global/app-examples-template/app-examples-template.qdoc @@ -21,8 +21,7 @@ \section1 Platform notes - + \section1 UI walkthrough @@ -53,6 +52,9 @@ + + \include squish-tested-example.qdocinc + \section1 Source files \sa {All Qt Examples},