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

QDoc incorrectly handles a missing return type in "\fn" command

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: P3: Somewhat important
    • Resolution: Invalid
    • Affects Version/s: 6.3.0
    • Fix Version/s: None
    • Component/s: Build tools: qdoc
    • Labels:
      None

      Description

      QDoc is intended to require the return type to be specified in an "\fn" command, as currently specified by the documentation.

       

      Failure to do so should report a clear warning to the user and avoid further processing of the topic-related documentation.

       

      QDoc doesn't seem to currently handle this correctly as it does not issue a clear enough warning and might, in some cases, produce correct documentation from an incorrectly specified "\fn" command.

        Attachments

          Issue Links

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

            Activity

              People

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

                Dates

                Created:
                Updated:
                Resolved:

                  Gerrit Reviews

                  There are no open Gerrit changes