Recommending proper API code examples for documentation purpose

Lee Wei Mar, Ye Chi Wu, Hewijin-Christine Jiau

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

9 Citations (Scopus)

Abstract

Code examples are important resources for expressing correct application programming interface (API) usages. However, many framework and library APIs fail in offering sufficient code examples in corresponding API documentations. This is because constructing proper code examples for documentation purpose takes significant developers' efforts. To reduce such effort, this work proposes a methodology, PropER-Doc, that recommends proper code examples for documentation purpose. PropER-Doc accepts queries from API developers and utilizes code search engines (CSEs) to collect corresponding code example candidates. The structural and conceptual links between API elements are captured from the API implementation and available API documents to guide candidate recommendation. During recommendation, PropER-Doc groups collected candidates based on involved API types for distinguishing different API usages. To assist API developers in selecting proper candidates, a diagrammatic presentation and three code example appropriateness metrics are also developed in PropER-Doc. Two case studies on Eclipse JDT framework are conducted to confirm the effectiveness of PropER-Doc.

Original languageEnglish
Title of host publicationProceedings - 18th Asia-Pacific Software Engineering Conference, APSEC 2011
Pages331-338
Number of pages8
DOIs
Publication statusPublished - 2011 Dec 1
Event18th Asia Pacific Software Engineering Conference, APSEC 2011 - Ho Chi Minh, Viet Nam
Duration: 2011 Dec 52011 Dec 8

Publication series

NameProceedings - Asia-Pacific Software Engineering Conference, APSEC
ISSN (Print)1530-1362

Other

Other18th Asia Pacific Software Engineering Conference, APSEC 2011
CountryViet Nam
CityHo Chi Minh
Period11-12-0511-12-08

All Science Journal Classification (ASJC) codes

  • Software

Fingerprint Dive into the research topics of 'Recommending proper API code examples for documentation purpose'. Together they form a unique fingerprint.

Cite this