kdevelop documentation

Amilcar do Carmo Lucas amilcar at ida.ing.tu-bs.de
Fri Oct 17 13:49:03 UTC 2003


Hello.

As you all may have noticed we get a daily mail, with the doxygen 
errors, in the mailing list.
Around 30% of those errors are due to the fact that ktown (the server 
where the doxygen process runs)
generates a Doxyfile without the kdelibs tags.

The errors I'm talking about look like this:
/home/apidox/src/cvs-api/kdevelop/buildtools/autotools/kfilednddetailview.h:88 
Warning: unable to resolve reference to `KURL' for \ref command

If you look at the daily mail from ktown you'll notice:
#---------------------------------------------------------------------------
# Configuration::addtions related to external references
#---------------------------------------------------------------------------
TAGFILES = ./apidocs/qt/qt.tag=http://doc.trolltech.com/3.2
GENERATE_TAGFILE =

But the correct Doxyfile AFAIK would look like this:

#---------------------------------------------------------------------------
# Configuration::addtions related to external references
#---------------------------------------------------------------------------
TAGFILES 
=/home/apidox/src/cvs-api/kdelibs-apidocs/dcop/dcop.tag=../../dcop/html/ \
 /home/apidox/src/cvs-api/kdelibs-apidocs/interfaces/interfaces.tag=../../interfaces/html/ 
\
 /home/apidox/src/cvs-api/kdelibs-apidocs/kdecore/kdecore.tag=../../kdecore/html/ 
\
 /home/apidox/src/cvs-api/kdelibs-apidocs/kdefx/kdefx.tag=../../kdefx/html/ 
\
 /home/apidox/src/cvs-api/kdelibs-apidocs/kdeui/kdeui.tag=../../kdeui/html/ 
\
 /home/apidox/src/cvs-api/kdelibs-apidocs/khtml/khtml.tag=../../khtml/html/ 
\
 /home/apidox/src/cvs-api/kdelibs-apidocs/kio/kio.tag=../../kio/html/ \
 /home/apidox/src/cvs-api/kdelibs-apidocs/kjs/kjs.tag=../../kjs/html/ \
 /home/apidox/src/cvs-api/kdelibs-apidocs/kparts/kparts.tag=../../kparts/html/ 
\
 /home/apidox/src/cvs-api/kdelibs-apidocs/kspell/kspell.tag=../../kspell/html/ 
\
 /home/apidox/src/cvs-api/kdelibs-apidocs/kutils/kutils.tag=../../kutils/html/ 
\
./apidocs/qt/qt.tag=http://doc.trolltech.com/3.2
GENERATE_TAGFILE =


So please do NOT try to fix the "unable to resolve reference to".
They will all be fixed when the sysadmin at kde.org fixes the cron job 
script that daily
generates the Doxyfile that ktown uses.

But please fell free to solve the other errors. The most complicated 
ones are the ones about class redefenition
(two classes share the same name in the global namespace):

/home/apidox/src/cvs-api/kdevelop/buildtools/qmake/trollprojectwidget.h:89 
Warning: class ProjectItem already has a brief description
skipping the one found here.
/home/apidox/src/cvs-api/kdevelop/buildtools/qmake/trollprojectwidget.h:111 
Warning: class SubprojectItem already has a brief description
skipping the one found here.
/home/apidox/src/cvs-api/kdevelop/vcs/cvsservice/changelog.h:23 Warning: 
class ChangeLogEntry already has a detailed description. Skipping the 
one found here.
/home/apidox/src/cvs-api/kdevelop/vcs/cvsservice/changelog.h:23 Warning: 
class ChangeLogEntry already has a brief description
skipping the one found here.
/home/apidox/src/cvs-api/kdevelop/vcs/cvsservice/checkoutdialog.h:30 
Warning: class CheckoutDialog already has a detailed description. 
Skipping the one found here.
/home/apidox/src/cvs-api/kdevelop/vcs/cvsservice/checkoutdialog.h:30 
Warning: class CheckoutDialog already has a brief description
skipping the one found here.
/home/apidox/src/cvs-api/kdevelop/vcs/cvsservice/tagdialog.h:24 Warning: 
class TagDialog already has a detailed description. Skipping the one 
found here.
/home/apidox/src/cvs-api/kdevelop/vcs/cvsservice/tagdialog.h:24 Warning: 
class TagDialog already has a brief description
skipping the one found here.

To solve those we need to add namespaces to those classes.

-- 
Amilcar Lucas

PS: THE SEARCH ENGINE WORKS!!!!! :)






More information about the KDevelop-devel mailing list