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

QDoc macro expansion breaks one-line code snippets

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P1: Critical
    • Resolution: Done
    • Affects Version/s: 5.12.0
    • Fix Version/s: None
    • Component/s: Build tools: qdoc
    • Labels:
      None

      Description

      Generating documentation across dev, I found these warnings from QDoc:

      /home/paul/source/qt/qt5/qtdatavis3d/examples/datavisualization/itemmodel/doc/src/itemmodel.qdoc:120: (qdoc) warning: Unknown macro 'endcode'
      /home/paul/source/qt/qt5/qtdatavis3d/src/datavisualization/data/qbar3dseries.cpp:258: (qdoc) warning: Unknown macro 'endcode'
      /home/paul/source/qt/qt5/qtdatavis3d/src/datavisualization/data/qbar3dseries.cpp:258: (qdoc) warning: Missing '\endcode'

      The first line is:

      \code GraphDataGenerator generator(graph, tableWidget); \endcode

      It seems the macro expansion causes some confusion, where QDoc interprets the \endcode as a macro rather than command. This causes a mismatch between \code and \endcode commands throughout the document.

      This likely affects multi documents, thus the priority.

        Attachments

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

          Activity

            People

            • Assignee:
              treinio Topi Reiniƶ
              Reporter:
              paulwicking Paul Wicking
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Gerrit Reviews

                There are no open Gerrit changes