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

Keeping version numbers current in documentation, tutorials, etc.

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Done
    • Icon: P2: Important P2: Important
    • None
    • 5.4.0
    • Documentation
    • None

      After downloading Qt 5.4, I found that documentation (including help files, tutorials, example code comments, etc) has not kept up with current version numbers. Some docs refer to Qt 5.3.x and Qt Creator 3.2.x as the latest version. Other docs have the same issue with OS X, Xcode, etc.

      For example,

      {http://doc.qt.io/qt-5/ios-support.html#getting-started}

      says, "... Note: As required by Apple, you should always use the latest Xcode 5 version when building your applications for the App Store. In practice this means you need OS X 10.8 or 10.9 to do iOS development with Qt, as those are the only platforms where Xcode 5 will run. ...". (The current versions today are Xcode 6.1 and OS X 10.10.1, respectively, but might be different next month.)

      A fix to satisfy documentation quality control standards is probably going to be harder than it looks at first glance, but should be possible by creating meta-docs with substitution codes to build up-to-date docs with correct version references. Then, as new versions become standard, just update the relevant version codes to generate new docs to be included in the next Qt release.

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

            docteam Qt Documentation Team
            wkrasl Walter Kraslawsky
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes