Adding Examples into Java Documents

—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. Keywords-API Documents; Examples; Structures; Code Clustering; Ranking;

• Type: Conference
• Year: 2009
• Where: KBSE
• Authors: Jinhan Kim, Sanghoon Lee, Seung-won Hwang, Sunghun Kim
• Keywords: API Documents, Code Examples, KBSE 2009, Software Engineering, Sufficient Code Examples