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

qdoc: Allow exclusion of source/header files based on wildcards

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: P2: Important
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 5.6.0
    • Component/s: Build tools: qdoc
    • Labels:
      None
    • Technical Risk:
      Normal
    • Commits:
      0ea13138 (qttools)

      Description

      Currently, QDoc includes all files from source/header directories that match a set file extension. It's possible to exclude files from the doc build with 'excludedirs' and 'excludefiles' - however, this doesn't easily allow exclusion of private header files (<filename>_p.h) located in the source directory along the public headers.

      For most modules, this a not an issue; QDoc parses the private header files, finds no documentation for them, and therefore (correctly) assumes they are private/internal. But for Qt 3D this is a problem: It has a lot of private classes in public namespaces, and because a namespace is public, QDoc generates documentation for everything it sees in it, including private classes (and complains about missing documentation for them).

      Therefore, QDoc needs a more flexible way to filter out source files, by using wildcards to match a filename pattern.

        Attachments

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

          Activity

            People

            Assignee:
            treinio Topi Reiniƶ
            Reporter:
            treinio Topi Reiniƶ
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                Gerrit Reviews

                There are no open Gerrit changes