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

Running "make docs" for Qt Creator results in way too many qdoc warnings

    XMLWordPrintable

Details

    • Bug
    • Resolution: Done
    • P2: Important
    • Qt Creator 4.12.0-beta1
    • Qt Creator 4.9.0, Qt Creator 4.11.1
    • Documentation
    • None
    • macOS

    Description

      I had to build Qt Creator from source today, to be able to build the docs for the Qt Application Manager Plugin. Sadly, there are way too many qdoc warnings. Some of them look clang-related, the others are just tons of undocumented parts.

      A quick estimate looks like there are at least 3000 odd warnings (attached). Can these warnings be fixed? This is definitely not a pleasant developer experience.

      Attachments

        Issue Links

          depends on

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-82252 Cannot generate documentation with Qt types

          • P1: Critical - Urgent and Important, will STOP the release if matched with set FixVersion field. This includes regressions from the last version that are not edge cases; Data loss; Build issues; All but the most unlikely crashes/lockups/hanging; Serious usability issues and embarrassing bugs & Bugs critical to a deliverable. This is the highest possible priority for requirements.
          • Closed
          For Gerrit Dashboard: QTCREATORBUG-22451
          # Subject Branch Project Status CR V
          262800,8 Fix qdoc call after it moved to LLVM/Clang master qt-creator/qt-creator Status: MERGED +2 0
          290879,1 WIP: Fix API documentation generation after qdoc moved to LLVM/Clang 4.12 qt-creator/qt-creator Status: ABANDONED -2 0
          291398,7 cmake build: Fix qdoc call for LLVM-based qdoc 4.12 qt-creator/qt-creator Status: MERGED +2 0

          Activity

            People

              con Eike Ziller
              kdpalara Kavindra Palaraja
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes