Aspect-oriented generation of the API documentation for AspectJ

  • Authors:

  • Michihiro Horie;Shigeru Chiba

  • Affiliations:

  • Tokyo Institute of Technology, Tokyo, Japan;Tokyo Institute of Technology, Tokyo, Japan

  • Venue:
  • Proceedings of the 4th workshop on Domain-specific aspect languages
  • Year:
  • 2009

Quantified Score

Hi-index 0.00

Visualization

Abstract

Through the development of a framework or a class library, writing the document on their application programming interface (API) is essential. The document on the API, which we call the API documentation, is mainly read by programmers who want to develop their applications on top of that framework or library. In this paper, we present a tool named CommentWeaver, which generates the API documentation of a framework/library written in AspectJ. CommentWeaver extracts the descriptions for the API documentation from both classes and aspects in the source files, and then it weaves them for generating the API documentation in HTML. Although ajdoc similarly generates the API documentation for AspectJ, the generated API documentation does not directly present the exact behavior of the API if it is affected by aspects.