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

Redesign documentation method for multi-module entities (namespaces)

    XMLWordPrintable

Details

    • Task
    • Resolution: Out of scope
    • Not Evaluated
    • None
    • 5.14.0 Alpha
    • Build tools: qdoc
    • None

    Description

      In QTBUG-79052, we try to address the problem of how to document a namespace that contains elements that are documented in different modules. The way this was addressed previously was to create "sub" files for the namespace in each module where its elements appeared and link to all those subfiles in the module where the \namespace command for the namespace appeared.

      This did work, prior to the introduction of the comments file change, but now it is causing problems (e.g. QTBUG-79052), and now we have another option for fixing it, namely using sub-comments files. The purpose of this task is to investigate that possibility - after the comments file change is integrated.

      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
              gbk Martin Smith (Qt)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes