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

Doc: Compile all snippets

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: In Progress
    • Priority: P1: Critical
    • Resolution: Unresolved
    • Affects Version/s: 5.14.0
    • Fix Version/s: None
    • Component/s: Documentation
    • Epic Name:
      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

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

            Activity

              People

              • Assignee:
                docteam Qt Documentation Team
                Reporter:
                paulwicking Paul Wicking
                RnD Owner:
                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