Constructing usage scenarios for API redocumentation

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

doi:10.1109/ICPC.2007.16

Constructing usage scenarios for API redocumentation

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

Research output: Chapters, Conference Papers, Creative and Literary Works › RGC 32 - Refereed conference paper (with host publication) › peer-review

19 Citations (Scopus)

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. ©2007 IEEE.

Original language	English
Title of host publication	IEEE International Conference on Program Comprehension
Pages	259-264
DOIs	https://doi.org/10.1109/ICPC.2007.16
Publication status	Published - 2007
Externally published	Yes
Event	15th IEEE International Conference on Program Comprehension, ICPC'07 - Banff, AB, Canada Duration: 26 Jun 2007 → 29 Jun 2007

Conference

Conference	15th IEEE International Conference on Program Comprehension, ICPC'07
Place	Canada
City	Banff, AB
Period	26/06/07 → 29/06/07

Access Output

10.1109/ICPC.2007.16

Other Access Options

Check CityUHK Library

Permanent Link

Right click to copy link

Cite this

@inproceedings{916b7668867e4bd49c5bacfbd208f038,

title = "Constructing usage scenarios for API redocumentation",

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. {\textcopyright}2007 IEEE.",

author = "Jiang Juanjuan and Johannes Koskinen and Anna Ruokonen and Tarja Syst{\"a}",

year = "2007",

doi = "10.1109/ICPC.2007.16",

language = "English",

isbn = "0769528600",

pages = "259--264",

booktitle = "IEEE International Conference on Program Comprehension",

note = "15th IEEE International Conference on Program Comprehension, ICPC'07 ; Conference date: 26-06-2007 Through 29-06-2007",

}

TY - GEN

T1 - Constructing usage scenarios for API redocumentation

AU - Juanjuan, Jiang

AU - Koskinen, Johannes

AU - Ruokonen, Anna

AU - Systä, Tarja

PY - 2007

Y1 - 2007

N2 - 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. ©2007 IEEE.

AB - 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. ©2007 IEEE.

UR - https://www.scopus.com/pages/publications/34948855957

UR - https://www.scopus.com/record/pubmetrics.uri?eid=2-s2.0-34948855957&origin=recordpage

U2 - 10.1109/ICPC.2007.16

DO - 10.1109/ICPC.2007.16

M3 - RGC 32 - Refereed conference paper (with host publication)

SN - 0769528600

SN - 9780769528601

SP - 259

EP - 264

BT - IEEE International Conference on Program Comprehension

T2 - 15th IEEE International Conference on Program Comprehension, ICPC'07

Y2 - 26 June 2007 through 29 June 2007

ER -

Constructing usage scenarios for API redocumentation

Abstract

Conference

Access Output

Other Access Options

Permanent Link

Other Files and Links

Fingerprint

Cite this