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

QDoc: Allow documentation to exist in header files

    XMLWordPrintable

Details

    • User Story
    • Resolution: Fixed
    • P2: Important
    • None
    • None
    • Build tools: qdoc
    • DaVinci 104, DaVinci 105, DaVinci 106
    • ba92ad037 (dev), d3cff9974 (dev), 05e51d405 (dev)

    Description

      As a developer, I want to write the documentation for my API in the header file where I declare it.

      Background: In Qt, documentation is contained in implementation files and .qdoc files. Other projects keep documentation comments in header files. This was raised as an obstacle in using QDoc for generating documentation for other projects during the Qt Contributor's Summit 2021.

      Attachments

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

        Activity

          People

            nicolasfella_kde Nicolas Fella
            paulwicking Paul Wicking
            Kimmo Leppälä Kimmo Leppälä
            Topi Reiniö Topi Reiniö
            Votes:
            2 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes