retitle 269635 Doxygen API documentation not built and installed
severity 269635 normal
stop

There is not a complete lack of API documentation - the doxygen docs are generated from the comments in the header files themselves - thus, the documentation exists, albeit without the hyperlinking and pleasant HTML formatting provided by doxygen.

Generating the doxygen docs is pretty simple:

Run:
doxygen doc/doxygen.conf
from the top of the Subversion source tree.

"builddir != sourcedir" arrangements require a little bit of additional manual hackery, I'm afraid:

cd $builddir
mkdir -p doc subversion
ln -s $sourcedir/subversion/include subversion/include
doxygen $sourcedir/doc/doxygen.conf

The output will be in doc/doxygen/html, install it to whereever you want.


From version 1.3, there is a "make doc-api" target, which is at the moment
simply runs "doxygen doc/doxygen.conf". I'll add the symlink hackery I described above for builddir != sourcedir builds to the make target.


Max.



--
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]

Reply via email to