Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • Users
  • Groups
  • Search
  • Get Qt Extensions
  • Unsolved
Collapse
Brand Logo
  1. Home
  2. Qt Development
  3. Qt Creator and other tools
  4. QDoc cannot change class header file shown in documentation.
Forum Updated to NodeBB v4.3 + New Features

QDoc cannot change class header file shown in documentation.

Scheduled Pinned Locked Moved Unsolved Qt Creator and other tools
4 Posts 3 Posters 535 Views 2 Watching
  • 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.
  • T Offline
    T Offline
    Tom.C Dev
    wrote on 31 Jan 2019, 17:44 last edited by
    #1

    Hi !

    I am trying QDoc to check if it can be an alternative to Doxygen. I have a problem regarding the header file shown in a class documentation.

    When QDoc generates the documentation for class "Something", the header file shown in the documentation will be #include<Something>. I would like to change this behaviour either by removing the information or by changing its content (e.g. #include <mydirectory/something.hpp>). I read QDoc documentation but it seems to be hardcoded in QDoc (though i hope not).

    J 1 Reply Last reply 1 Feb 2019, 05:12
    0
    • T Tom.C Dev
      31 Jan 2019, 17:44

      Hi !

      I am trying QDoc to check if it can be an alternative to Doxygen. I have a problem regarding the header file shown in a class documentation.

      When QDoc generates the documentation for class "Something", the header file shown in the documentation will be #include<Something>. I would like to change this behaviour either by removing the information or by changing its content (e.g. #include <mydirectory/something.hpp>). I read QDoc documentation but it seems to be hardcoded in QDoc (though i hope not).

      J Offline
      J Offline
      JKSH
      Moderators
      wrote on 1 Feb 2019, 05:12 last edited by
      #2

      @Tom.C-Dev said in QDoc cannot change class header file shown in documentation.:

      I am trying QDoc to check if it can be an alternative to Doxygen.

      Hi, be aware that QDoc's purpose is primarily for documenting Qt itself. It can be used for external libraries, but that's not its main goal so some things might not be supported.

      Is there a feature that you want that's in QDoc but not in Doxygen?

      Qt Doc Search for browsers: forum.qt.io/topic/35616/web-browser-extension-for-improved-doc-searches

      T 1 Reply Last reply 1 Feb 2019, 09:26
      1
      • J JKSH
        1 Feb 2019, 05:12

        @Tom.C-Dev said in QDoc cannot change class header file shown in documentation.:

        I am trying QDoc to check if it can be an alternative to Doxygen.

        Hi, be aware that QDoc's purpose is primarily for documenting Qt itself. It can be used for external libraries, but that's not its main goal so some things might not be supported.

        Is there a feature that you want that's in QDoc but not in Doxygen?

        T Offline
        T Offline
        Tom.C Dev
        wrote on 1 Feb 2019, 09:26 last edited by
        #3

        @JKSH said in QDoc cannot change class header file shown in documentation.:

        Is there a feature that you want that's in QDoc but not in Doxygen?

        I am not after a specific feature. QDoc just picked my interest.

        @JKSH said in QDoc cannot change class header file shown in documentation.:

        Be aware that QDoc's purpose is primarily for documenting Qt itself.

        From what i understand, QDoc has all the features required to generate documentation for any C++ API (since Qt is mainly a C++ framework with some extensions).

        1 Reply Last reply
        0
        • S Offline
          S Offline
          SGaist
          Lifetime Qt Champion
          wrote on 1 Feb 2019, 09:56 last edited by
          #4

          Hi,

          That's a pretty good question. I wold recommend bringing it to the interest mailing list. You'll find there qdoc developers/maintainers. This forum is more user oriented.

          Interested in AI ? www.idiap.ch
          Please read the Qt Code of Conduct - https://forum.qt.io/topic/113070/qt-code-of-conduct

          1 Reply Last reply
          1

          3/4

          1 Feb 2019, 09:26

          • Login

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