Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-94746 QDoc: Allow documentation to exist in header files
  3. QTBUG-129289

QDoc: Make it so that function documentation in header files do not unconditionally require an \fn command

    XMLWordPrintable

Details

    • Change Request
    • Resolution: Fixed
    • P2: Important
    • None
    • Build tools: qdoc
    • 5ebf824f8 (dev)
    • DaVinci 104, DaVinci 105, DaVinci 106

    Description

      With documentation in header files, QDoc requires all function documentation comments to have an \fn command. This differs from how QDoc works with documentation in implementation files, as there, QDoc attempts to automatically tie the documentation comment to the function definition that follows. This should be made to work in the same way without regard of whether the comment is in a header or implementation file, and it should work with automatic tying.

      Attachments

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

        Activity

          People

            treinio Topi Reiniƶ
            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