Having trouble to build Qt documentation from my project
-
I wrote comments in my code, using the "Writing Qt Documentation":http://qt-project.org/wiki/Writing_Qt_Documentation, as follow this simple example:
@
/*!- \brief blabla...
- \param blabla...
- \return blabla...
*/
bool update_object_list(const QList<SomeObject *> &list)
{
return ObjectDAO::instance()->updateObjectList(list);
}
@
My goal was to create a html document based on my comments, using the qdoc as the "Building Qt Documentation":http://qt-project.org/wiki/Building_Qt_Documentation shows.
This last guide requested my own project.qdocconf file, to configure the creation of the html documentation, based on my comments in the code. I created it as follows:
@
include(/usr/local/Qt-5.1.1/doc/global/compat.qdocconf)project = MyProject
description = System
version = 0.3.1outputformats = HTML
outputdir = /home/gustavo/htmlheaderdirs = /home/gustavo/MyProject/PersistenceModule
sourcedirs = /home/gustavo/MyProject/PersistenceModule
@So, I executed ...
/usr/local/Qt-5.1.1/bin/qdoc /home/gustavo/project.qdocconf
... and this dir structure was created:
$ ls -R html/
#--- start of output ---
html/: images myproject.index scripts style
html/images: bgrContent.png btn_prev.png bullet_sq.png ico_note.png used-in-examples btn_next.png bullet_dn.png ico_note_attention.png ico_out.png
html/images/used-in-examples: <empty>
html/scripts: <empty>
html/style: offline.css
#--- end of output ---
The file "myproject.index" have only this code inside:
@<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE QDOCINDEX>
<INDEX url="" title="System" version="0.3.1" project="MyProject">
<namespace access="public" threadsafety="unspecified" status="commendable" name="" href="" location=""/>
</INDEX>@So, as you can see, there is nothing useful produced by qdoc. And this is my problem.
I found here in Qt Forum a similar problem with no answers: "Using QDoc does not work at all":http://qt-project.org/forums/viewthread/25318.
I read at last:
- "Writing Qt Documentation":http://qt-project.org/wiki/Writing_Qt_Documentation
- "Building Qt Documentation":http://qt-project.org/wiki/Building_Qt_Documentation
- "Troubleshooting Qt Documentation":http://qt-project.org/wiki/Troubleshooting_Qt_Documentation
- A lot of more documents on Internet.
Can someone tell me what i am doing wrong?
Aditional information:
- I am using Qt 5.1.1
- Linux kernel 3.5.0-37-generic x86_64
-
May the binary gods of the object code help you.
o.OI have the same problems.
-
So, there are 3 people trying to solve it.