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

QDoc should allow setting the project name that's used as shorthand in the \since command

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Fixed
    • Icon: P2: Important P2: Important
    • 6.9.0 FF
    • None
    • Build tools: qdoc
    • None
    • afa9c763b (dev), b6d7b9eb9 (dev)
    • DaVinci 103

       QDoc's \since command allows authors to specify which version something was introduced to the product. If the argument to the command is only one element, the assumption is that it is a Qt version, and QDoc generates a line of text that includes "Qt" in the name. Any non-Qt project must therefore always include the product name as argument to the command, e.g. \since My Awesome Product 1.2.3. This causes needless repetition and may contribute to carpal tunnel syndrome, but the egregious part is that it's surprising for the author that 'Qt' is injected if they're unaware of this behavior.

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

            paulwicking Paul Wicking
            paulwicking Paul Wicking
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes