• DocumentCode
    3009395
  • Title

    Constructing Usage Scenarios for API Redocumentation

  • Author

    Jiang, Juanjuan ; Koskinen, Johannes ; Ruokonen, Anna ; Systä, Tarja

  • Author_Institution
    Inst. of Software Syst., Tampere Univ. of Technol., Tampere
  • fYear
    2007
  • fDate
    26-29 June 2007
  • Firstpage
    259
  • Lastpage
    264
  • Abstract
    Software development relies heavily on reusable libraries and software components. For correct use of the provided API, proper documentation is needed. API usage is often demonstrated by giving example applications and code samples. In this paper we propose an approach for mining such usage scenarios from run-time communication between sample applications and the API. This is done automatically by first monitoring the API usage of sample applications, then filtering the generated traces, and finally synthesizing the sequence diagrams and illustrating them in a well-formed way as UML2 sequence diagrams. Such usage scenarios support the software engineer in comprehending the usage of the API. With proper tool support they can also be used for validating other applications´ API usage and for generating code for a new application using the same API.
  • Keywords
    application program interfaces; system documentation; API redocumentation; API usage monitoring; application program interfaces; software development; Application software; Data mining; Documentation; Explosions; Filtering; Runtime; Software libraries; Software systems; Visualization; Web services;
  • fLanguage
    English
  • Publisher
    ieee
  • Conference_Titel
    Program Comprehension, 2007. ICPC '07. 15th IEEE International Conference on
  • Conference_Location
    Banff, Alberta, BC
  • ISSN
    1092-8138
  • Print_ISBN
    0-7695-2860-0
  • Type

    conf

  • DOI
    10.1109/ICPC.2007.16
  • Filename
    4268260