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

QDoc auto-links to \internal targets

    XMLWordPrintable

Details

    • Task
    • Resolution: Invalid
    • P2: Important
    • None
    • None
    • Build tools: qdoc
    • None
    • Incorrectly closed as fixed when the fix was squashed into a commit that didn't merge.

    • QDoc Sprint 1

    Description

      QDoc's auto-linker is slightly too eager to resolve link targets after the comment file feature; linking to even targets that are marked \internal.

      Most prominent is the word 'macOS', where we tried to disable the autolinking by introducing an internal \externalpage. For example;

      -<p>With the MySQL driver, it is possible to connect to a MySQL server. In order to build the QMYSQL Plugin for Unix or <a href="supported-platforms.html#macos">macOS</a>, you need the MySQL header files as well as the shared library, libmysqlclient.so. To compile the plugin for Windows, install MySQL.</p>
      +<p>With the MySQL driver, it is possible to connect to a MySQL server. In order to build the QMYSQL Plugin for Unix or <a href="nolink">macOS</a>, you need the MySQL header files as well as the shared library, libmysqlclient.so. To compile the plugin for Windows, install MySQL.</p>
      

      notice the <a href="nolink">macOS</a>, which obviously is not intended.

      Attachments

        Issue Links

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

          Activity

            People

              treinio Topi Reiniƶ
              treinio Topi Reiniƶ
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes