[sword-devel] Doxyfile patch and Documentation for 1.6.0

[Greg Hellings]

Troy,

Since the Doxyfile was moved from the root of the SWORD source to the
doc/ directory, some of its paths needed to be updated.  As such, the
Doxyfile in 1.6.0 and SVN won't work without the attached patch (I
suppose it might if you're in the root of SWORD and manually invoke
"doxygen doc/Doxyfile" from there).  With the patch applied, you need
only drop into the doc/ directory of library and issue the command
"doxygen" and it will generate the documents, provided you have the
necessary libraries, etc.

Also, you can find the generated HTML version of the docs at
http://www.crosswire.org/~ghellings/1_6_0classdocs
LaTeX documents are also generated by the Doxyfile for compilation to
PDF, but the resulting PDF doesn't look so great because of the
massive images files for the UML inheritance tree.  I might think
about taking those images out of the PDFs for future releases if
people are highly interested in the PDF versions of the docs.

--Greg
-------------- next part --------------
A non-text attachment was scrubbed...
Name: doxyfile.diff
Type: text/x-patch
Size: 927 bytes
Desc: not available
URL: <http://www.crosswire.org/pipermail/sword-devel/attachments/20090516/79ba7ef7/attachment.bin>