Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-40432 Qt 5 Documentation CSS issues
  3. QTBUG-37361

HTML output of qdoc's \br command is incorrect

    XMLWordPrintable

Details

    • Technical task
    • Resolution: Done
    • P4: Low
    • 5.4.0
    • Build tools: qdoc
    • None
    • 4f2d1e2e048765b65cbe4511b408684f625c38fa (qtbase)

    Description

      The HTML output of qdoc's \br command is incorrect, probably since the \br macro was promoted to a qdoc command (QTBUG-26435). The expected HTML output would be:

      <br />
      

      The actual HTML output is:

      </p>
      <br />
      <p>
      

      For an example of the outcome, see the gap between the copyright statements at http://doc-snapshot.qt-project.org/qt5-stable/licenses.html#parts-of-the-codecs-implemented-by-qt.

      Given the facts that \br is still undocumented as a qdoc command and that even qtdoc/doc/global/macros.qdocconf still defines macro.br.HTML = "<br />", the result is really confusing.

      I guess the issue is triggererd by leavePara() in qtbase/src/tools/qdoc/doc.cpp DocParser::parse() at:

                      case CMD_BR:
                          leavePara();
                          append(Atom::BR);
                          break;
      

      (Maybe the leavePara() was motivated by DITAXML output?)

      Attachments

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

        Activity

          People

            treinio Topi Reiniƶ
            dg0yt Kai Pastor
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes