• DocumentCode
    1851099
  • Title

    Adding Examples into Java Documents

  • Author

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

  • Author_Institution
    Pohang Univ. of Sci. & Technol., Pohang, South Korea
  • fYear
    2009
  • fDate
    16-20 Nov. 2009
  • Firstpage
    540
  • Lastpage
    544
  • 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.
  • Keywords
    Java; application program interfaces; document handling; API documents; JDK 5 documents; Java documents; JavaDocs 5; application programming interfaces; Application software; Automatic programming; Data mining; Feature extraction; Humans; Java; Libraries; Productivity; Search engines; Software engineering; API Documents; Code Clustering; Examples; Ranking; Structures;
  • fLanguage
    English
  • Publisher
    ieee
  • Conference_Titel
    Automated Software Engineering, 2009. ASE '09. 24th IEEE/ACM International Conference on
  • Conference_Location
    Auckland
  • ISSN
    1938-4300
  • Print_ISBN
    978-1-4244-5259-0
  • Electronic_ISBN
    1938-4300
  • Type

    conf

  • DOI
    10.1109/ASE.2009.39
  • Filename
    5431739