Adding examples into Java documents

Jinhan Kim, Sanghoon Lee, Seung Won Hwang, Sunghun Kim

Research output: Chapter in Book/Report/Conference proceedingConference contribution

27 Citations (Scopus)

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.

Original languageEnglish
Title of host publicationASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering
Pages540-544
Number of pages5
DOIs
Publication statusPublished - 2009 Dec 1
Event24th IEEE/ACM International Conference on Automated Software Engineering, ASE2009 - Auckland, New Zealand
Duration: 2009 Nov 162009 Nov 20

Publication series

NameASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering

Other

Other24th IEEE/ACM International Conference on Automated Software Engineering, ASE2009
CountryNew Zealand
CityAuckland
Period09/11/1609/11/20

Fingerprint

Application programming interfaces (API)

All Science Journal Classification (ASJC) codes

  • Computer Science Applications
  • Software

Cite this

Kim, J., Lee, S., Hwang, S. W., & Kim, S. (2009). Adding examples into Java documents. In ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering (pp. 540-544). [5431739] (ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering). https://doi.org/10.1109/ASE.2009.39
Kim, Jinhan ; Lee, Sanghoon ; Hwang, Seung Won ; Kim, Sunghun. / Adding examples into Java documents. ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering. 2009. pp. 540-544 (ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering).
@inproceedings{196428d54bfc410e8b9068744c5eb7ac,
title = "Adding examples into Java documents",
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.",
author = "Jinhan Kim and Sanghoon Lee and Hwang, {Seung Won} and Sunghun Kim",
year = "2009",
month = "12",
day = "1",
doi = "10.1109/ASE.2009.39",
language = "English",
isbn = "9780769538914",
series = "ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering",
pages = "540--544",
booktitle = "ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering",

}

Kim, J, Lee, S, Hwang, SW & Kim, S 2009, Adding examples into Java documents. in ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering., 5431739, ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering, pp. 540-544, 24th IEEE/ACM International Conference on Automated Software Engineering, ASE2009, Auckland, New Zealand, 09/11/16. https://doi.org/10.1109/ASE.2009.39

Adding examples into Java documents. / Kim, Jinhan; Lee, Sanghoon; Hwang, Seung Won; Kim, Sunghun.

ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering. 2009. p. 540-544 5431739 (ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering).

Research output: Chapter in Book/Report/Conference proceedingConference contribution

TY - GEN

T1 - Adding examples into Java documents

AU - Kim, Jinhan

AU - Lee, Sanghoon

AU - Hwang, Seung Won

AU - Kim, Sunghun

PY - 2009/12/1

Y1 - 2009/12/1

N2 - 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.

AB - 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.

UR - http://www.scopus.com/inward/record.url?scp=77952160060&partnerID=8YFLogxK

UR - http://www.scopus.com/inward/citedby.url?scp=77952160060&partnerID=8YFLogxK

U2 - 10.1109/ASE.2009.39

DO - 10.1109/ASE.2009.39

M3 - Conference contribution

AN - SCOPUS:77952160060

SN - 9780769538914

T3 - ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering

SP - 540

EP - 544

BT - ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering

ER -

Kim J, Lee S, Hwang SW, Kim S. Adding examples into Java documents. In ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering. 2009. p. 540-544. 5431739. (ASE2009 - 24th IEEE/ACM International Conference on Automated Software Engineering). https://doi.org/10.1109/ASE.2009.39