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

qdoc: Add warnings for linking / formatting commands used within section titles

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • 6.4
    • Build tools: qdoc
    • None

    Description

      Currently QDoc allow linking and formatting commands to be used within section titles (the argument for \section1..N commands).

      This practice is not encouraged however, as it's often visually distracting and the same information would work better in the section content.

      The only situation where it's useful and justifiable is API reference-style documentation where argument/return types and/or values of a signature are styled/linked to, similar to how QDoc formats the C++/QML reference it generates. This is an exception and rarely used, so we should add warnings whenever such commands are used within section titles.

      Attachments

        Issue Links

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

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              treinio Topi Reiniƶ
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes