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

Replace direct links to https://doc.qt.io/qt-6/

    XMLWordPrintable

Details

    • Bug
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • 6.10
    • Documentation
    • None

    Description

      We have nowadays a few places where Qt documentation uses external links

      $ cd qtdoc && git grep "doc.qt.io/qt-6/"
      ...
      doc/src/howtos/installer-cli.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-essentials} {essential module libraries}
      doc/src/howtos/installer-cli.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-essentials} {essential module libraries}
      doc/src/howtos/installer-cli.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-essentials} {essential module libraries}
      doc/src/howtos/installer-cli.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-add-ons} {add-on module libraries}
      doc/src/howtos/installer-cli.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-essentials} {essential module libraries}
      doc/src/howtos/installer-cli.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-add-ons} {add-on module libraries}
      doc/src/howtos/installer-cli.qdoc:                   \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-essentials} {essential module libraries}
      doc/src/howtos/installer-cli.qdoc:                   \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-add-ons} {add-on module libraries}
      doc/src/platforms/debian-packages.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-essentials} {essential module libraries}
      doc/src/platforms/debian-packages.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-essentials} {essential module libraries}
      doc/src/platforms/debian-packages.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-essentials} {essential module libraries}
      doc/src/platforms/debian-packages.qdoc:             \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-add-ons} {add-on module libraries}
      doc/src/platforms/debian-packages.qdoc:                   \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-essentials} {essential module libraries}
      doc/src/platforms/debian-packages.qdoc:                   \li \l {https://doc.qt.io/qt-6/qtmodules.html#qt-add-ons} {add-on module libraries}
      doc/src/platforms/vxworks.qdoc:    \li Add Qt CMake related code to the CMakeLists.txt following \l {https://doc.qt.io/qt-6/cmake-get-started.html#building-a-c-gui-applicationCMakeLists.txt} {Getting started with CMake}.
      doc/src/platforms/wasm.qdoc:\l{https://doc.qt.io/qt-6/resources.html}{Qt Resource System}
      doc/src/platforms/wasm.qdoc:\l{https://doc.qt.io/qt-6/qfontdatabase.html#addApplicationFontFromData}{QFontDatabase::addApplicationFontFromData}.
      doc/src/platforms/windows.qdoc:        (unless you enabled a \l {https://doc.qt.io/qt-6/configure-options.html#developer-builds}
      examples/demos/android/splashscreen/manifest/doc/src/qt-splashscreen-in-android.qdoc:    \li \l {https://doc.qt.io/qt-6/android-manifest-file-configuration.html#qt-specific-meta-data}{android.app.splash_screen_drawable}
      examples/demos/android/splashscreen/manifest/doc/src/qt-splashscreen-in-android.qdoc:    \li \l {https://doc.qt.io/qt-6/android-manifest-file-configuration.html#qt-specific-meta-data}{android.app.splash_screen_sticky}
      

      These should be replaced by internal links to either titles/sections, or (preferably) \target's:

      • Dangling links then become a qdoc warning instead of a 404
      • The links also work in Qt Assistant / Qt Creator help mode
      • The link point to the same version of the Qt documentation

      Attachments

        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 is 1 open Gerrit change