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

Review documentation of Application Examples

    XMLWordPrintable

Details

    Description

      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:

      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.

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

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

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes