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

QDoc needs a \pseudocode block type between \badcode and \code

XMLWordPrintable

    • Icon: Suggestion Suggestion
    • Resolution: Duplicate
    • Icon: P3: Somewhat important P3: Somewhat important
    • None
    • 6.4
    • Build tools: qdoc
    • None
    • All

      When I encounter code wrapped in \badcode\endcode it always jars if the code in the block is not, in fact, bad. I'm not sure why this is used in place of \code\endcode, but I'm guessing the latter does some level of "checking" that assumes C++ or some such, making it unsuitable for use on build-configuration code and similar.
      Furthermore, this widespread practice means that we can't style \badcode blocks in a way that alerts the user to "don't do this", because so many of them are not, in fact, bad code; so the tag's usage is at odds with its name, precluding doing something that would be sensible for it, if they two were aligned.

      We either need some form of parameter to \code to tell it the language or whatever else it needs to let us use it without the problems that lead to use of \badcode in its place, or should add a separate \pseudocode for the middle-ground; code-like stuff exempt from what's special about \code, but that shouldn't be considered "bad".

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

            docinfrastructure Documentation Infrastructure Team
            Eddy Edward Welbourne
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved:

                There are no open Gerrit changes