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
Index: doc/Doxyfile
===================================================================
--- doc/Doxyfile	(revision 2414)
+++ doc/Doxyfile	(working copy)
@@ -62,7 +62,7 @@
 # If a relative path is entered, it will be relative to the location 
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = doc/doxygen
+OUTPUT_DIRECTORY       = doxygen
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
 # 4096 sub-directories (in 2 levels) under the output directory of each output 
@@ -537,7 +537,7 @@
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT                  = src include utilities
+INPUT                  = ../src ../include ../utilities
 
 # This tag can be used to specify the character encoding of the source files 
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is 
_______________________________________________
sword-devel mailing list: [email protected]
http://www.crosswire.org/mailman/listinfo/sword-devel
Instructions to unsubscribe/change your settings at above page

Reply via email to