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. How to make qdoc of my module accessible in QT Creator?
Forum Updated to NodeBB v4.3 + New Features

How to make qdoc of my module accessible in QT Creator?

Scheduled Pinned Locked Moved Solved General and Desktop
3 Posts 2 Posters 701 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.
  • AlienA Offline
    AlienA Offline
    Alien
    wrote on last edited by Alien
    #1

    I use the below example :
    https://github.com/retifrav/qdoc-example
    to provide qt documentation out of config.qdocconf and I use qdoc tool to provide the htmls the output of qdoc is :

    LOG: Start qdoc for Qdoc-Example in dual process mode, 
    LOG: No include paths passed to qdoc; guessing reasonable include paths
    LOG: Build & visit PCH for Qdoc-Example
    (qdoc) Could not find the module header in include paths for module "Qdoc-Example"   (include paths:  QVector() )
           Artificial module header built from header dirs in qdocconf file
    LOG: clang not printing errors; include paths were guessed
    LOG: PCH built & visited for Qdoc-Example
    LOG: Parse source files for Qdoc-Example
    LOG: No include paths passed to qdoc; guessing reasonable include paths
    LOG: Source files parsed for Qdoc-Example
    /home/user/Documents/qdoc-example-test/AwesomeUIControl.qml:4: (qdoc) warning: '\brief' statement does not end with a full stop.
    /home/user/Documents/qdoc-example-test/AwesomeUIControl.qml:4: (qdoc) warning: Could not resolve QML import statement for type 'AwesomeUIControl'
        [Maybe you forgot to use the '\inqmlmodule' command?]
    LOG: End qdoc for Qdoc-Example in dual process mode, 
    
    

    And now i have html files in doc folder.

    What should I do to present the documentation recognizable to QT Creator?(How to install the doc in QT in a way when user press F1 on my module the right documentation be available to her)

    Yours,
    Alien

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

      Hi,

      Adding external documentation to Qt Creator is described here.

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

      AlienA 1 Reply Last reply
      2
      • SGaistS SGaist

        Hi,

        Adding external documentation to Qt Creator is described here.

        AlienA Offline
        AlienA Offline
        Alien
        wrote on last edited by
        #3

        Dear @SGaist,
        Thanks I appreciate your help
        Yours,

        1 Reply Last reply
        1

        • Login

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