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

Qt 6.9 API Review - API Documentation

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • P1: Critical
    • None
    • None
    • Documentation
    • None

    Description

      Let's make sure that the documentation for new or changed API in Qt 6.9 is up to date:

      All new classes/QML types/properties/functions ... are properly documented

      • API is marked with \since 6.9
      • Description is understandable & complete
      • New API or class is properly linked from related documentation

      All deprecated classes/QML types/properties/functions ... are properly documented

      • API is marked with \deprecated [6.9]
      • Description explains why the API is deprecated and points to alternatives
      • References to API are updated to point to alternatives

      Reference

      https://codereview.qt-project.org/q/topic:api-change-review-6.9

      https://codereview.qt-project.org/q/topic:qml_api_review_6.9

      https://doc-snapshots.qt.io/qt6-6.9/newclasses69.html

      https://doc-snapshots.qt.io/qt6-6.9/obsoleteclasses.html

      https://wiki.qt.io/Writing_Qt_Documentation

       

       

      Attachments

        Issue Links

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

          Activity

            People

              Unassigned Unassigned
              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