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

QDoc: \page command translates underscores to hyphens

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • P3: Somewhat important
    • 6.2.2
    • 6.2.0
    • Build tools: qdoc
    • None
    • Da Vinci sprint 43

    Description

      Given the following \page command:

      \page this_is_my_page.html

      I'd expect the generated html file is indeed this_is_my_page.html. However, QDoc translates the underscores to hyphens and generates this-is-my-page.html instead.

      This was surprising to me. At the very least, QDoc should issue a warning that the input to the command is going to be modified in output.

      (I understand a possible reason for this is to unify output in multi-author environments such as Qt, another reason may be that Google recommends hyphens over underscores. These are good reasons for the behavior, but do not make up for the element of surprise therein.)

      Attachments

        For Gerrit Dashboard: QTBUG-97174
        # Subject Branch Project Status CR V

        Activity

          People

            diseraluca Luca Di Sera
            paulwicking Paul Wicking
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes