[September 21, 2000] Apache Cocoon JavaDoc Documentation in XML. " We are currently [2000-09] working on enhancing the documentation provided for the Cocoon XML publishing framework by converting javadoc commented source code into XML for use within Cocoon. In order to do this we are currently planning to implement the following phases: (1) Develop a JavaDoc XML DTD that acts as a data structure representing the information provided by the rootDoc object of the SUN Javadoc program to a plugged doclet. This DTD is intended to closely mirror the look of a raw java source file. (2) Develop a JavaDoc doclet (JavaDocXML) that takes the information from the JavaDoc rootDoc object and converts it into an XML file using the javadoc.dtd. (3) Wrap the javadoc with XML doclet invocation into a cocoon producer (4) Some final formats we could produce are (a) javadoc.dtd ---> javadoc_html.dtd ---> HTML (this would create a javadoc that looks like the current HTML javadoc standard). (b) javadoc.dtd ---> docBook.dtd (this would facilitate printed books based having heavy content about java API's. For example 'The JDBC API Tutorial and Reference: 2nd Edition' could make heavy use of this. (c) javadoc.dtd ---> ebook.dtd (this would facilitate the electronic version of documentation) (d) javadoc.dtd ---> xxx ---> pdf. (5) Using this method we will then enhance the existing Cocoon documentation to provide rich documentation using some subset of the above formats. (6) Finally, we can incorporate XML versions of UML vector diagrams to further enhance the source code documentation. ...The first phase has been complete and a complete javadoc DTD was created. We feel confortable with the solidity of that DTD and we plan to move over to the actual XML doclet implementation." From the 'Apache JavaDoc DTD version 0.4-draft' release: "This DTD is designed to capture the output of JavaDoc as an XML document through the use of the JavaDocXML Doclet. The hope is that by having the JavaDoc documentation in an XML format, it will be easier for application developers working with XML to treat their java source documentation in the same way they treat any other XML document within their publication framework. This DTD should reflect the information contained within the RootDoc object passed to the JavaDocXML Doclet by JavaDoc."
References:
