Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-136955

Review documentation of Application Examples

XMLWordPrintable

    • framework-content 14, framework-content 15, framework-content 16, framework-content 17

      Review and unify the documentation for the Qt Application Examples.

      Proposed structure:

      Overview

      Purpose of example. Which Qt technologies are used? What Qt features are shown?

      h3 Launching

      Look for template in qtbase -> https://github.com/qt/qtbase/blob/dev/doc/global/includes/examples-run.qdocinc

      mention also limitations of target platforms, if there are any.

      h3 Walkthrough

      UI walkthrough (optional)

      h3 <Feature A>

      Explain the implementation of the feature in the code.

      h3 <Feature B>
      ...

      Furthermore, the example should get appropriate tags.

       

      Note from intranet page, https://qtgroup.atlassian.net/wiki/spaces/QTRD/pages/123814308/Documentation+and+Tools+OKR+s+-+2025+June-Sept#General :

      Highlight purpose (best practices and use cases, modules used, target platforms). Link to further documentation where needed.

      Also, tags will be added to all examples as part of the bigger tagging initiative.

        1.
        		 Revise Car Configurator example Sub-task In Progress Safiyyah Moosa
        2.
        		 Revise File System Explorer example Sub-task Reported Qt Documentation Team
        3.
        		 Revise Getting Started Programming with Qt Quick example Sub-task In Progress Jaishree Vyas
        4.
        		 Revise Media Player example Sub-task In Review Jerome Pasion
        5.
        		 Revise Photo Surface example Sub-task In Review Andreas Eliasson
        6.
        		 Revise Qt Quick Demo - RESTful API client example Sub-task In Progress Andreas Eliasson
        7.
        		 Revise Robot Arm example Sub-task In Review Andreas Eliasson
        8.
        		 Revise Same Game example Sub-task Reported Qt Documentation Team
        9.
        		 Revise Thermostat example Sub-task In Review Andreas Eliasson
        10.
        		 Revise To Do List example Sub-task In Review Andreas Eliasson
        11.
        		 Revise WebEngine Quick Nano Browser example Sub-task Reported Qt Documentation Team
        12.
        		 Revise Window Embedding example Sub-task Reported Qt Documentation Team
        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

            docteam Qt Documentation Team
            kkohne Kai Köhne
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:

                There are no open Gerrit changes