I suspect the reason why we are silent about building documentation is because nobody ever asks. You are the first (to my knowledge). To build the docs, you should do the following:
set your JAVA_HOME
set your PATH to include the location for Doxygen and Graphviz
set your CLASSPATH to include ant.jar, tools.jar, xml-apis.jar, xercesImpl.jar, xalan.jar, and stylebook-1.0-b3_xalan-2.jar
cd to $XALANCROOT
invoke the command "build.sh docs"
If you have any problems, please post back ..
June K. Ng
| "Jeroen N. Witmond"
<[EMAIL PROTECTED]>
05/06/2005 12:58 PM
|
|
I want to generate the documentation for Xalan-c, but could not easily
find out how to do that: http://xml.apache.org/xalan-c/ is silent on this
subject. I also could not find anything relevant in the (user) mailing
list, using http://marc.theaimsgroup.com/?l=xalan-c-users . Please note
that the EyeBrowse archive
http://mail-archives.apache.org/eyebrowse/SummarizeList?listId=75
mentioned on http://xml.apache.org/mail.html does not work.
However, being familiar with Xerces-c, I found some hints in directory
$XALANCROOT/xdocs, specifically files $XALANCROOT/xdocs/run and
$XALANCROOT/xdocs/DoxyfileXalan.
$XALANCROOT/xdocs/run requires me to download some java stuff, which made
me wonder. First of all, generating documentation is an XML transform, so
why can't Xalan-c perform this function? Next is the question why I should
download this, where it already is present in Xerces-c, which is required
by Xalan-c. Therefore I changed $XALANCROOT/xdocs/run:
--- run 12 Feb 2003 09:28:53 -0000 1.1
+++ run 6 May 2005 16:38:04 -0000
@@ -10,9 +10,10 @@
# the basic HTML documentation for xalan-c
-STYLEBOOK_JAR=$STYLEBOOK_PATH/bin/stylebook-1.0-b2.jar
-XALAN_JAR=$STYLEBOOK_PATH/bin/xalan.jar
-XERCES_JAR=$STYLEBOOK_PATH/bin/xerces.jar
+STYLEBOOK_PATH=$XERCESCROOT/tools/jars
+STYLEBOOK_JAR=$STYLEBOOK_PATH/stylebook-1.0-b2.jar
+XALAN_JAR=$STYLEBOOK_PATH/xalan.jar
+XERCES_JAR=$STYLEBOOK_PATH/xerces.jar
CLASSPATH=$STYLEBOOK_JAR:$XALAN_JAR:$XERCES_JAR
Unfortunately, this fails with message: [XercesParser] File
"sbk:/style/dtd/book.dtd" not found. [File: "sbk:/sources/xalan.xml" Line:
0 Column: 0]
Question: How do I go from here?
When I run doxygen version 1.4.2 in directory $XALANCROOT/xdocs I get the
following warnings and errors:
Warning: Tag `CGI_NAME' at line 543 of file DoxyfileXalan has become
obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"
Warning: Tag `CGI_URL' at line 549 of file DoxyfileXalan has become obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"
Warning: Tag `DOC_URL' at line 555 of file DoxyfileXalan has become obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"
Warning: Tag `DOC_ABSPATH' at line 561 of file DoxyfileXalan has become
obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"
Warning: Tag `BIN_ABSPATH' at line 566 of file DoxyfileXalan has become
obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"
Warning: Tag `EXT_DOC_PATHS' at line 572 of file DoxyfileXalan has become
obsolete.
To avoid this warning please update your configuration file using "doxygen
-u"
Searching for include files...
Searching for example files...
Searching for images...
Searching for dot files...
Searching for files to exclude
Reading input files...
Reading and parsing tag files
Error: tag OUTPUT_DIRECTORY: Output directory `../build/docs' does not
exist and cannot be created
Question: How do I go from here?
If you need more information or a formal bug report, please let me know.
Regards,
Jeroen.
