Adding Examples into Java Documents

Jinhan Kim, Sanghoon Lee, Seung-won Hwang, Sunghun Kim

DOI 10.1109/ase.2009.39 dblp

Abstract

Code examples play an important role to explain the usage of Application Programming Interfaces (APIs), but most API documents do not provide sufficient code examples. For example, for the JDK 5 documents (JavaDocs), only 2% of APIs have code examples. In this paper, we propose a technique that automatically augments API documents with code examples. Our approach finds and embeds code examples for more than 75% of the APIs in JavaDocs 5.

BibTeX

@inproceedings{Kim-al:ASE09,
  author    = {Jinhan Kim and
               Sanghoon Lee and
               Seung{-}won Hwang and
               Sunghun Kim},
  title     = {Adding Examples into Java Documents},
  booktitle = {ASE},
  pages     = {540--544},
  publisher = {{IEEE} Computer Society},
  year      = {2009},
}

Adding Examples into Java Documents

Abstract

Related papers