Important: Please read the Qt Code of Conduct - https://forum.qt.io/topic/113070/qt-code-of-conduct

Cant get QDoc to work



  • I have set up a minimal qdoc config file

    include(C:\Qt\5.12.2\mingw73_64\doc\global\compat.qdocconf)
    outputdir = html
    headerdirs = ./
    sourcedirs = ./
    exampledirs = ./
    imagedirs

    I run this command

    c:\qt\5.12.2\mingw73_64\bin\qdoc.exe ./ProfileTest.qdocconf

    and an index is produced but putting this in a browser gives

    This XML file does not appear to have any style information associated with it. The document tree is shown below.

    This is the index file

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE QDOCINDEX>
    <INDEX url="" title="" version="" project="">
    <namespace threadsafety="unspecified" name="" status="active" access="public" documented="false"/>
    </INDEX>

    What am I doing wrong

    Thanks


  • Moderators

    @GrahamLa said in Cant get QDoc to work:

    What am I doing wrong

    You're using qdoc, which is an internal Qt documentation tool - it does not guarantee any stability, API, etc.. Consider using doxygen instead.


  • Moderators

    @GrahamLa
    backslash is considered as escape character, try using a slash instead.
    Also your imagedirs variable is incomplete
    also see this

    Maybe you also want to include the online or offline template:

    include($QTDIR/doc/global/qt-html-templates-offline.qdocconf)
    # or
    include($QTDIR/doc/global/qt-html-templates-online.qdocconf)
    

Log in to reply