Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. General and Desktop
  4. Is QDoc an available tool ?If not, why there are no warnings in documentation
Forum Update on Monday, May 27th 2025

Is QDoc an available tool ?If not, why there are no warnings in documentation

Scheduled Pinned Locked Moved Unsolved General and Desktop
4 Posts 3 Posters 557 Views
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • Stephen INFS Offline
    Stephen INFS Offline
    Stephen INF
    wrote on last edited by aha_1980
    #1

    I really tried,but still don't know how to make it work to generate C++ ducumentation.Has anyone successfully used it?(Since Qt 5.11)

    Related issues:
    https://forum.qt.io/topic/101833/cant-get-qdoc-to-work/2
    https://forum.qt.io/topic/102055/why-qdoc-don-t-work-it-s-really-confusing
    https://forum.qt.io/topic/99203/qdoc-cannot-change-class-header-file-shown-in-documentation/3
    https://forum.qt.io/topic/81725/qt-auto-generating-documentation-tools

    Thanks for any suggestions.

    aha_1980A 1 Reply Last reply
    0
    • Stephen INFS Stephen INF

      I really tried,but still don't know how to make it work to generate C++ ducumentation.Has anyone successfully used it?(Since Qt 5.11)

      Related issues:
      https://forum.qt.io/topic/101833/cant-get-qdoc-to-work/2
      https://forum.qt.io/topic/102055/why-qdoc-don-t-work-it-s-really-confusing
      https://forum.qt.io/topic/99203/qdoc-cannot-change-class-header-file-shown-in-documentation/3
      https://forum.qt.io/topic/81725/qt-auto-generating-documentation-tools

      Thanks for any suggestions.

      aha_1980A Offline
      aha_1980A Offline
      aha_1980
      Lifetime Qt Champion
      wrote on last edited by
      #2

      @Stephen-INF

      Has anyone successfully used it?(Since Qt 5.11)

      All Qt docs are generated with it, so it surely works. And generating Qt documentation is its primary goal.

      But if you have problems, why not use doxygen?

      Qt has to stay free or it will die.

      Stephen INFS 1 Reply Last reply
      0
      • aha_1980A aha_1980

        @Stephen-INF

        Has anyone successfully used it?(Since Qt 5.11)

        All Qt docs are generated with it, so it surely works. And generating Qt documentation is its primary goal.

        But if you have problems, why not use doxygen?

        Stephen INFS Offline
        Stephen INFS Offline
        Stephen INF
        wrote on last edited by
        #3

        @aha_1980
        Because QDoc is inside Qt,can be used directly on different platforms.I really want to try it.It would be appreciated if you could give me an example.

        1 Reply Last reply
        0
        • mrjjM Offline
          mrjjM Offline
          mrjj
          Lifetime Qt Champion
          wrote on last edited by mrjj
          #4

          Hi
          I also tried QDoc and after long time of checking paths and trying older versions of LLVM
          i gave up.
          It always says
          /QDocTester/mainwindow.cpp:27: (qdoc) warning: clang found diagnostics parsing \fn MainWindow::MainWindow(QWidget *parent)
          error: use of undeclared identifier 'MainWindow'
          error: unknown type name 'QWidget'

          if it sees a /fn tag
          (tried other types/classes too )

          tried various ways to tell where to look with the config.qdocconf
          file but either currentdir (.) or full path seems to make a difference.

          But most other tags works. it does produce output
          just not for /fn.

          1 Reply Last reply
          0

          • Login

          • Login or register to search.
          • First post
            Last post
          0
          • Categories
          • Recent
          • Tags
          • Popular
          • Users
          • Groups
          • Search
          • Get Qt Extensions
          • Unsolved