qdoc problem

[codeman]

Hello friends,

after generating my qch file I add the file to qtcreator documentation list. So after I click on my doc it claims:

Die Seite konnte nicht gefunden werden
Fehler beim Laden: qthelp://company.labs.qtestclass.540/qtestclass/index.html

Die Seite konnte nicht gefunden werden
Fehler beim Laden: qthelp://company.labs.qtestclass.540/qtestclass/index.html

To copy to clipboard, switch view to plain text mode 

There is no index.html file on generating docs:

1. qdoc qtestclass.qdocconf
2. qhelpgenerator.exe ".\doc\qtestclass.qhp"


Is there any mini example on how to produce qt like documentation?!

[wysota]

Did you generate index page in qdoc?

[codeman]

Yes there is also an *.index file after evaluate

qdoc qtestclass.qdocconf

qdoc qtestclass.qdocconf

To copy to clipboard, switch view to plain text mode 

[wysota]

I meant index.html page not an index of pages.

[codeman]

No there isn´t a page you mentioned.

[wysota]

So it is nothing unexpected that the viewer cannot find it

You should create the page yourself, as far as I remember you can do that with:

/**
  \page index
  \title Title of the page
 
  Contents of the page
*/

/**
  \page index
  \title Title of the page

  Contents of the page
*/

To copy to clipboard, switch view to plain text mode 

[codeman]

Ok creating file is trivial, but it seem I have a gap in understanding how to refer to the correect uri. qthelp doesnt find the uri

"qthelp://company.labs.qtestclass.540/qtestclass/index.html"

[wysota]

I'm not sure what you mean. If you setup the virtual folder correctly in one of Qt help files (don't remember which one right now) all should be fine. Did you follow the documentation on how to create help files? Were any pages actually generated? Can you see the html files at all?

[codeman]

Hello,


this is my qdocconf file:

#include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
#include($QT_INSTALL_DOCS/global/externalsites.qdocconf)
 
project                 = qtestclass
description             = qtestclass Reference Documentation
version                 = $QT_VERSION
language = Cpp
 
qhp.projects            = qtestclass
 
qhp.qtestclass.file         = qtestclass.qhp
qhp.qtestclass.namespace           = company.labs.qtestclass.$QT_VERSION_TAG
qhp.qtestclass.virtualFolder       = qtestclass
qhp.qtestclass.indexTitle          = qtestclass
qhp.qtestclass.indexRoot           =
 
qhp.qtestclass.filterAttributes    = qtestclass $QT_VERSION qtrefdoc
qhp.qtestclass.customFilters.Qt.name = qtestclass $QT_VERSION
qhp.qtestclass.customFilters.Qt.filterAttributes = qtestclass $QT_VERSION
 
 
 
outputdir  =    ./doc/
 
headerdirs  += ..
sourcedirs  += ..
 
sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"
 
navigation.landingpage = "qtestclass"
navigation.qmltypespage = "qtestclass QML Type"
 
HTML.extraimages             += images/qt-codesample.png
qhp.QtDoc.extraFiles         += images/qt-codesample.png
 
# Add an .html file with sidebar content, used in the online style
HTML.stylesheets             += style/qt5-sidebar.html

#include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
#include($QT_INSTALL_DOCS/global/externalsites.qdocconf)

project                 = qtestclass
description             = qtestclass Reference Documentation
version                 = $QT_VERSION
language = Cpp

qhp.projects            = qtestclass

qhp.qtestclass.file         = qtestclass.qhp
qhp.qtestclass.namespace           = company.labs.qtestclass.$QT_VERSION_TAG
qhp.qtestclass.virtualFolder       = qtestclass
qhp.qtestclass.indexTitle          = qtestclass
qhp.qtestclass.indexRoot           =

qhp.qtestclass.filterAttributes    = qtestclass $QT_VERSION qtrefdoc
qhp.qtestclass.customFilters.Qt.name = qtestclass $QT_VERSION
qhp.qtestclass.customFilters.Qt.filterAttributes = qtestclass $QT_VERSION



outputdir  =    ./doc/

headerdirs  += ..
sourcedirs  += ..

sources.fileextensions = "*.cpp *.qdoc *.mm *.qml"
headers.fileextensions = "*.h *.ch *.h++ *.hh *.hpp *.hxx"

navigation.landingpage = "qtestclass"
navigation.qmltypespage = "qtestclass QML Type"

HTML.extraimages             += images/qt-codesample.png
qhp.QtDoc.extraFiles         += images/qt-codesample.png
                    
# Add an .html file with sidebar content, used in the online style
HTML.stylesheets             += style/qt5-sidebar.html

To copy to clipboard, switch view to plain text mode 

Then I make :

qdoc qtestclass.qdocconf

qdoc qtestclass.qdocconf

To copy to clipboard, switch view to plain text mode 

This creates: qtestclass.html;qtestclass.index;qtestclass.qhp;qt estclass-members.html
in doc folder.

Then for creating qch:

qhelpgenerator.exe ".\doc\qtestclass.qhp"

qhelpgenerator.exe ".\doc\qtestclass.qhp"

To copy to clipboard, switch view to plain text mode 

adding the file to assistant or qtcreator gives me

Die Seite konnte nicht gefunden werden
Fehler beim Laden: qthelp://company.labs.qtestclass.540/qtestclass/index.html

So I read the docs for creating those qdocconf files etc. But I miss a little example which compiles and result in correct documentation.

[wysota]

So you have a list of files without a "index.html" entry and you are wondering why a page called "index.html" cannot be found, correct?

[codeman]

The documentary did not say anything about the too-existing files. That's why I know not at all what I should be surprised about.
I do not know at what goes in or what goes out.

[wysota]

The documentary did not say anything about the too-existing files.

I'm sorry, I don't know what "too-existing" means.

That's why I know not at all what I should be surprised about.
I do not know at what goes in or what goes out.

qhelpgenerator doesn't create documentation files out of thin air, if they don't exist at the moment when qhelpgenerator is run, they will not be included in the archive. Thus if index.html does not exist as you didn't document the page, it will not go into the qch file and will not be found when someone tries to access it.

[codeman]

too-existing: files that has to be exists.

I respect your knowlegde, but you explain things like a miracle for me(yes thats my problem I know).
After running qdoc which section of the documentation says, "the generated files are:" or "after that process there will be created these files etc".

I have no overview of the ingredients. Do you understand my dilemma...

[wysota]

qdoc is not a magic wand, it creates documentation files out of qualified comments you have to put in your code (like those in post #6). If you don't put any qualified comments, qdoc will not generate any pages. The tool is documented, if you want to use it, I suggest you start by reading its manual.

E.g. there is a qtbase/src/corelib/doc/src/qtcore-index.qdoc file which is responsible for documenting a qtcore-index.html page which is then displayed as the landing page for "Qt Core" help in Qt5.