You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@xalan.apache.org by bu...@apache.org on 2003/09/17 22:56:49 UTC

DO NOT REPLY [Bug 20572] - javadoc build fails

DO NOT REPLY TO THIS EMAIL, BUT PLEASE POST YOUR BUG 
RELATED COMMENTS THROUGH THE WEB INTERFACE AVAILABLE AT
<http://nagoya.apache.org/bugzilla/show_bug.cgi?id=20572>.
ANY REPLY MADE TO THIS MESSAGE WILL NOT BE COLLECTED AND 
INSERTED IN THE BUG DATABASE.

http://nagoya.apache.org/bugzilla/show_bug.cgi?id=20572

javadoc build fails

richcao@ca.ibm.com changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
           Keywords|                            |PatchAvailable



------- Additional Comments From richcao@ca.ibm.com  2003-09-17 20:56 -------
The problem with building with JDK1.4 is that the custom javadoc tool
(xalan2jdoc.jar) relies on some special Doclet APIs [1] that were changed in 1.4. 

These APIs are marked as "subject to change without notice" by Sun, so we
decided to use the Taglet [2] to implement the JavaDocs for JDK1.4. The taglet
is found in the xalan2jtaglet.jar file. 

To enable use of the taglet, we needed to change the <meta name="usage"
content="xxx"> to the JavaDoc tagformat, namely @x xxx.  The attached perl
script will recursively update the tags to @xsl.usage xxxx.

The Taglet only works in 1.4, so for 1.3 and below, I've updated the
xalan2jdoc.jar to handle the @xsl.usage tags.

The Ant built will recognize the version of Java and call the correct JavaDoc
build commands.

If anyone needs the source of the jars, please send me an email.

So in summary, to get this fix working: 

1. place xalan2jtaglet.jar and xalan2jdoc.jar in xml-xalan\java\bin
2. run the perl script from the xml-xalan directory (or specify the directory as
a parameter)
3. apply the patch to build.xml

[1] http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/standard-doclet.html
[2] http://java.sun.com/j2se/1.4.2/docs/tooldocs/javadoc/taglet/overview.html