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

Doc: Compile all snippets

    XMLWordPrintable

Details

    • Epic
    • Status: In Progress
    • P1: Critical
    • Resolution: Unresolved
    • 5.14.0
    • None
    • Documentation
    • Compile doc snippets

    Description

      We should eliminate as many hard-coded snippets, and use \quotefromfile or \snippet commands instead to quote code from actual, working code. This will also help in porting the code from C++ to Python (for PySide).

      The purpose is to ensure that the snippets represent real use of the API, and that API changes do not invalidate the snippets. See Qt Bluetooth for an example of how this can be achieved. This needs to be run in CI, perhaps only on Linux. Compile only, no auto-tests.

      Attachments

        Issue Links

          For Gerrit Dashboard: QTBUG-74787
          # Subject Branch Project Status CR V

          Activity

            People

              docteam Qt Documentation Team
              paulwicking Paul Wicking
              Paul Wicking Paul Wicking
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes