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

Add comments file handling to QDoc

    XMLWordPrintable

Details

    • Task
    • Resolution: Incomplete
    • P2: Important
    • None
    • None
    • Build tools: qdoc
    • None
    • QDoc Sprint 1, QDoc Sprint 2, QDoc Sprint 3

    Description

      Investigate a possible improvement to qdoc by adding comment file handling to qdoc and then seeing how it works. This involves creating a new qdoc class, QDocCommentFiles, which will be a lot like QDocIndexFiles. QDocCommentFiles will read and write a comment file for each module in a parallel way to how QDocIndexFiles reads and writes an index file for each module. It is believed this will allow the generate phase to be reduced to reading the index files required by the module, including the index file of the module itself, and reading the comment file for the module as well. Then the html files can be generated. The PCH is then no longer required for the generate phase, and qdoc no longer needs to read all the source files.

      Attachments

        Issue Links

          depends on

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-79201 qdoc: References to self are hyperlinked.

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-78887 The Header and qmake sections are missing from output

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-78888 Default values set in function signatures are missing in output

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-78889 The reimp information is lost from output

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-78904 Type information is missing from the property summary section

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-78905 Q_INVOKABLE note is removed

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-78906 Inherited members list is dropped for qml documentation

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-78909 Missing content in qhp files

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79039 Missing examples-manifest.xml files

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79043 qdoc: Missing prev/next page navigation

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79044 Tags-files are generated without any sub-elements

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79052 Obsolete members pages get renamed

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79053 Possible failure in linking to qtcore targets

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79060 QDoc strips ending punctuation mark in some cases

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79062 Links to anchors dropped from html

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79108 QDoc auto-links to \internal targets

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79135 qdoc: Add a way to ignore specific words from being auto-linked

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79191 qdoc: Missing title for QML basic types

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79204 qdoc: Anchoring for property groups nodes is lost

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79207 qdoc: Primary tree not prioritized in search order

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79273 Autolinker selects first overload of overloaded methods as target

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79293 qdoc: Related nonmember typedef's are not linked

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79308 QDoc: possible error in linking to typedefs

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79309 Empty link to qobject.html# inserted in class members lists

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79310 QDoc: Ellipsis dropped from function signatures in some cases

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79355 Formalize QDoc's stand-alone mode

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79364 Inherited property groups missing in qml docs

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79367 Possible issue with some qml-foo.html links

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79581 qdoc: Missing type information for variables

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-79582 Adoption of related non-members needs to be improved

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed

          Task - A task that needs to be done. QTBUG-78957 qdoc: Handle missing .index and/or comments file in generate phase

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Task - A task that needs to be done. QTBUG-79065 Complete member lists contain an extra html link to qobject

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Task - A task that needs to be done. QTBUG-79205 qdoc: Default attribute for QML properties is lost

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Task - A task that needs to be done. QTBUG-79306 QDoc may write out empty Namespaces sections

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Task - A task that needs to be done. QTBUG-79341 qdoc: Errant markup in generated brief descriptions

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Task - A task that needs to be done. QTBUG-79625 qdoc: enums using \ingroup are not listed as members of the group

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Task - A task that needs to be done. QTBUG-79307 QDoc: Extra, empty table added to module pages

          • P4: Low - Would be nice to fix, but it's not very important.
          • Closed
          is required for

          User Story - Created by Jira Software - do not edit or delete. Issue type for a user story. QTBUG-79002 Test comments file generation

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Withdrawn
          relates to

          Task - A task that needs to be done. QTBUG-79358 Squash changes into parent patch

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Closed

          Suggestion - Public suggestions QTBUG-79197 qdoc: Allow \inmodule for a \qmltype

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Reported

          Task - A task that needs to be done. QTBUG-79136 """ character entities replaced with "

          • P4: Low - Would be nice to fix, but it's not very important.
          • Closed
          resulted in

          User Story - Created by Jira Software - do not edit or delete. Issue type for a user story. QTBUG-78886 QDoc should run faster

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Open
          For Gerrit Dashboard: QTBUG-77196
          # Subject Branch Project Status CR V
          268735,44 QDoc: Use only index files and comment file in generate phase dev qt/qttools Status: ABANDONED 0 0
          270900,16 qdoc: WIP processing comment files 2 dev qt/qttools Status: ABANDONED -2 0

          Activity

            People

              gbk Martin Smith (Qt)
              gbk Martin Smith (Qt)
              Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes