Donald M. Leslie
ABSTRACT
The creation of API reference documentation and its integration into larger documentation sets present a number of challenges. This paper explores a strategy for using Javadoc, the primary mechanism for generating Java API documentation, in conjunction with an XML infrastructure, to improve the quality of API reference material and its integration into product documentation sets.
- Apache Software Foundation, Xalan Java. http://xml.apache.org/xalan-j/index.htmlGoogle Scholar
- Apache Software Foundation, Xerces Java.Parser http://xml.apache.org/xerces-j/index.htmlGoogle Scholar
- Brooks, F. The Mythical Man Month. Addison-Wesley, Boson, MA, 1995, 169. Google ScholarDigital Library
- Day, D., Priestley, M. and Schell, D. Introduction to the Darwin Information Typing Architecture: Toward portable technical information. IBM DeveloperWorks, 2001-2002. http://www106.ibm.com/developerworks/xml/library/x-dita1/Google Scholar
- Doc++ http://www.zib.de/Visual/software/doc++/Google Scholar
- Doclet.com, Zentech, Inc. http://www.doclet.com/Google Scholar
- Document Object Model (DOM) http://www.w3.org/DOM/Google Scholar
- DocWiz http://www.mindspring.com/~chroma/docwiz/Google Scholar
- Doxygen http://www.doxygen.org/Google Scholar
- Harold, E. R., and Means, W. S. XML in a Nutshell: A Deskotp Quick Reference. O'Reilly and Associates, Inc., Sebastopol, CA, 2001. Google ScholarDigital Library
- Java API for XML Processing (JAXP) http://java.sun.com/xml/jaxp/index.htmlGoogle Scholar
- Javadoc Tool Home Page http://java.sun.com/j2se/javadoc/Google Scholar
- JTidy HTML Parser and Pretty Printer in Java. http://www.lempinen.net/sami/jtidy/.Google Scholar
- Priestley, M. Specializing topic types in DITA: Creating new topic-based document types. IBM DevelperWorks 2001-2002. http://www-106.ibm.com/developerworks/xml/library/x-dita2/Google Scholar
- SAX (Simple API for XML) http://www.saxproject.org/Google Scholar
- SAXON XSLT Processor http://saxon.sourceforge.net/Google Scholar
Index Terms
- Using Javadoc and XML to produce API reference documentation
Recommendations
Tool support for crosscutting concerns of API documentation
AOSD '10: Proceedings of the 9th International Conference on Aspect-Oriented Software DevelopmentWriting detailed API (Application Programming Interface) documentation is a significant task for developing a good class library or framework. However, existing documentation tools such as Javadoc provide only limited support and thus the description ...
API documentation from source code comments: a case study of Javadoc
SIGDOC '99: Proceedings of the 17th annual international conference on Computer documentationThis paper describes in a general way the process we went through to determine the goals, principles, audience, content and style for writing comments in source code for the Java platform at the Java Software division of Sun Microsystems. This includes ...
Transforming documentation from the XML doctypes used for the apache website to DITA
SIGDOC '01: Proceedings of the 19th annual international conference on Computer documentationA primary factor behind the enormous interest in XML is the support it provides for transforming documents to meet the needs of information-processing applications as well as human readers working with HTML, print, and other presentation media. This ...
Comments