Using Javadoc and XML to produce API reference documentation

  • Authors:
  • Donald M. Leslie

  • Affiliations:
  • Apache Software Foundation

  • Venue:
  • Proceedings of the 20th annual international conference on Computer documentation
  • Year:
  • 2002

Quantified Score

Hi-index 0.00

Visualization

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.