Uploaded image for project: 'Qt Creator'
  1. Qt Creator
  2. QTCREATORBUG-23544

Fix QDoc warnings in the Extending Qt Creator Manual

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Closed
    • Priority: P2: Important
    • Resolution: Done
    • Affects Version/s: Qt Creator 4.11.0
    • Fix Version/s: Qt Creator 4.12.0-beta1
    • Component/s: Documentation
    • Labels:
      None
    • Commits:
      e12ba2d68312434f50437c3b01f12834926eeb3b (qt-creator/qt-creator/master)
    • Sprint:
      DaVinci sprint 3

      Description

      The Extending Qt Creator Manual will be published at doc.qt.io (in addition to the current snapshot release), so it would be good to fix at least the obvious QDoc warnings, such as wrong document signatures in \fn commands, wrong QDoc commands, and other QDoc formatting issues.

      Fix the warnings for the following libs and plugins and hide the rest:

      • src/libs/aggregation 
      • src/libs/extensionsystem

      After this is done, start documenting the rest in the order of importance (will create separate tasks for this):

      • src/plugins/coreplugin/actionmanager
      • src/plugins/coreplugin
      • src/plugins/vcsbase
      • src/plugins/projectexplorer (undergoing heavy changes)
      • src/plugins/texteditor
      • src/libs/utils

      The priority of documenting the rest will be determined case-by-case.

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              leenam Leena Miettinen
              Reporter:
              leenam Leena Miettinen
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: