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

Generate disambiguation pages

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • P2: Important
    • 5.0.0
    • None
    • Documentation
    • None
    • bb27a0b2b7b9c229c774a0d903a02349be9edbea 47420cf05b820dbcf864f82ac3f461015a3e303f

    Description

      Now that we have QML module identifiers, the standard way to link to, e.g., a QML property, is to construct the link from the QML module name, the QML component name, and the property name, like this:

      \l

      {QtQuick2::Item::anchors.top}

      {top}

      But there is a lot of documentation that refers to things without the QML module identifier, e.g.:

      \l{Item::anchors.top} {top}

      These references without the QML module identifier should still work, but they don't because qdoc complains that the QML module identifier is missing, and it really can't determine whether the writer wants to link to the anchors.top property in QtQuick 1 or the one in QtQuick 2.

      So this task creates a disambiguation page for each QML element/component that exists in more than one QML module. The links without the QML module identifier then can link to a list of possibilities on the disambiguation page. When the user clicks on the link without the QML identifier, he is taken to the appropriate list on the disambiguation page, where he chooses the appropriate link to the final target.

      Attachments

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

        Activity

          People

            gbk Martin Smith (Qt)
            gbk Martin Smith (Qt)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes