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

QDoc: Allow \fn commands to be split over multiple lines

    XMLWordPrintable

Details

    • Task
    • Resolution: Unresolved
    • P2: Important
    • None
    • None
    • Build tools: qdoc
    • None
    • DaVinci 92

    Description

      QDoc allows user to document a callable element by usage of an "\fn" topic command.

       

      Generally, an "\fn" commands accepts an argument, that spans up to the end of the line with some small exceptions, that more or less encodes the information that QDoc needs to understand which element the user is trying to document.

       

      For C++ methods/function, the information can be quite verbose. Especially as QDoc supports more of the C++ concepts.

      For example, a recent change now requires the user to provide information about template declarations for C++ callables (QTBUG-118080).

       

      Due to the amount of information required, forcing the argument to be laid out on a single line makes an "\fn" command not only difficult to read and identify, but difficult to maintain.

       

      Hence, QDoc should allow the user to lay out the argument for an "\fn" command over multiple lines, to simplify both writing and reading the instances of the commands that are information dense.

      Attachments

        Issue Links

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

          Activity

            People

              docinfrastructure Documentation Infrastructure Team
              diseraluca Luca Di Sera
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes