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. QDoc is not generating output for \property and \enum
Qt 6.11 is out! See what's new in the release blog

QDoc is not generating output for \property and \enum

Scheduled Pinned Locked Moved Unsolved General and Desktop
1 Posts 1 Posters 189 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.
  • T Offline
    T Offline
    Taher Lkdw
    wrote on last edited by
    #1

    Hello,

    I'm using QDoc to document the application i'm developing using Qt Qml. It works great overall only except it is not generating output for \property and \enum tag.
    I have Q_PROPERTY in .hpp file, for that i have added the comment in cpp as below:
    /*! \property AppLockerUIManager::appsListModel \brief Returns pointer of AppsListModel class. */

    For which it throws an error as below:
    Cannot find 'AppLockerUIManager::appsListModel' specified with '\property' in any header file

    Same is true for \enum tags:
    Cannot find 'AppSettings::Key' specified with '\enum' in any header file

    The enums and properties are available in header file. The same is working for \fn tag.

    Here is my config.qdocconf file:

    includepaths = . \
               .. \
               ../.. \
               ./includes \
               $QT_INSTALL_HEADERS \
               $QT_INSTALL_HEADERS/QtCore \
               $QT_INSTALL_HEADERS/QtGui \
               $QT_INSTALL_HEADERS/QtQuick \
               $QT_INSTALL_DOCS
    
    indexes = $QT_INSTALL_DOCS/qtcore/qtcore.index \
                $QT_INSTALL_DOCS/qtqml/qtqml.index \
                $QT_INSTALL_DOCS/qtquick/qtquick.index \
                $QT_INSTALL_DOCS/qtdoc/qtdoc.index
    
    include($QT_INSTALL_DOCS/global/qt-module-defaults-online.qdocconf)
    include($QT_INSTALL_DOCS/config/exampleurl-qtbase.qdocconf)
    
    defines += qt6
    depends += \
       qtcore \
       qtqml \
       qtquick \
       qtdoc
    
    project = Fortify-TheAppLocker
    version = $QT_VERSION
    url = http://doc.felgo.io/fortify
    qhp = true
    qhp.projects            = Fortify
    qhp.Fortify.file                = fortify.qhp
    qhp.Fortify.namespace           = org.qt-project.fortify.$QT_VERSION_TAG
    qhp.Fortify.virtualFolder       = fortify
    qhp.Fortify.indexTitle          = Fortify-TheAppLocker
    qhp.Fortify.indexRoot           =
    
    qhp.Fortify.subprojects         = classes
    qhp.Fortify.subprojects.classes.title = C++ Classes
    qhp.Fortify.subprojects.classes.indexTitle = Fortify Main Application
    qhp.Fortify.subprojects.classes.selectors = class fake:headerfile
    qhp.Fortify.subprojects.classes.sortPages = true
    
    headers.fileextensions  = "*.h *.hpp"
    sources.fileextensions  = "*.cpp *.qml *.qdoc"
    outputdir = ../../Docs/
    imagedirs = images
    headerdirs  = . ../.. ../../src
    sourcedirs  = . \
    		./src \
                    ../.. \
                    ../../src
    		
    
    moduleheader = FortiyMainApplicationDoc
    navigation.homepage  = Fortify-index.html
    navigation.hometitle = "Fortify-TheAppLocker"
    navigation.cppclassespage = "Fortify Main Application"
    

    Please help me understand how to resolve this errors.
    Also i could not find the documentation on how to document signals implemented in cpp class.

    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