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

Qt doesn't warn about undocumented methods

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: In Progress
    • Priority: P3: Somewhat important
    • Resolution: Unresolved
    • Affects Version/s: 6.3.0
    • Fix Version/s: None
    • Component/s: Build tools: qdoc
    • Labels:
      None
    • Sprint:
      DaVinci 58, DaVinci 59

      Description

      qdoc should warn about methods that are not documented. Anyhow, this doesn't work reliably, at least - see also the attached project:

      project = test
      outputdir   = html
      headers = a.h
      sources = a.cpp
      headerdirs  = .
      sourcedirs  = .
      
      class A {
      public:
          A() {}
      
          void f() { }
          void g();
          void h();
      };
      
      #include "a.h"
      
      /*!
        \class A
        \brief Powerful class for doing A.
        \inmodule test
      
        A is a class.
       */
      
      void A::g()
      {
      
      }
      
      /*!
        Does h() on a A class
       */
      void A::h()
      {
      }
      

      I would have expected some warnings from qdoc about the missing documentation for f(), g(). Anyhow, the output doesn't indicate anything:

      C:\dev\tmp\qtbug-104614>C:\Qt\6.3.0\msvc2019_64\bin\qdoc.exe qdocwarnings.qdocconf
      qt.qdoc: Start qdoc for test in dual process mode: generate phase.
      qt.qdoc: No include paths passed to qdoc; guessing reasonable include paths
      (qdoc) Could not find the module header in include paths for module "test"   (include paths:  QList() )
             Artificial module header built from header dirs in qdocconf file
      qt.qdoc: Parse source files for "test"
      qt.qdoc: No include paths passed to qdoc; guessing reasonable include paths
      qt.qdoc: Source files parsed for "test"
      qt.qdoc: End qdoc for test in dual process mode: generate phase.
      

        Attachments

          Issue Links

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

            Activity

              People

              Assignee:
              docinfrastructure Documentation Infrastructure Team
              Reporter:
              kkohne Kai Köhne
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:

                  Gerrit Reviews

                  There are no open Gerrit changes