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. Replace "Header: #include <CCryptoThread> " for generated documentation to correct string.
Forum Updated to NodeBB v4.3 + New Features

Replace "Header: #include <CCryptoThread> " for generated documentation to correct string.

Scheduled Pinned Locked Moved Unsolved Qt Creator and other tools
4 Posts 2 Posters 1.0k Views 1 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.
  • O Offline
    O Offline
    ovasyura
    wrote on last edited by
    #1

    QDoc assumes that header file is the same as name of the class in documentation.
    \class CCryptoThread

    But in custom project it is not. I have header file CCryptoThread.h and perhaps can be even another header file where CCryptoThread. class is declared.
    Is it possible to set for QDoc to include correct header string in the documentation like?

    Header: #include <CCryptoThread.h> 
    

    Unfortunately I cannot find but it is strange that it could not be possible because it is common task for using QDoc for customer projects.

    1 Reply Last reply
    0
    • SGaistS Offline
      SGaistS Offline
      SGaist
      Lifetime Qt Champion
      wrote on last edited by
      #2

      Hi,

      Do you mean that you will have the exact same class declared several times in your project ?

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

      O 1 Reply Last reply
      0
      • SGaistS SGaist

        Hi,

        Do you mean that you will have the exact same class declared several times in your project ?

        O Offline
        O Offline
        ovasyura
        wrote on last edited by
        #3

        @SGaist No. By default QDoc puts the following string in generated documentation for my class:

        #include <CCryptoThread> 
        

        But in my code the header file is: CCryptoThread.h, or even more correct : ccryptoheader.h
        Therefore in generated documentation for class should be the real header file where class is declared:

        #include <cryptoheader.h> 
        

        How can I reach such case?

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

          You can try to use the inheaderfile keyword.

          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
          0

          • Login

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