2012 34th International Conference on Software Engineering (ICSE) 2012
DOI: 10.1109/icse.2012.6227140
|View full text |Cite
|
Sign up to set email alerts
|

Synthesizing API usage examples

Abstract: Abstract-Key program interfaces are sometimes documented with usage examples: concrete code snippets that characterize common use cases for a particular data type. While such documentation is known to be of great utility, it is burdensome to create and can be incomplete, out of date, or not representative of actual practice.We present an automatic technique for mining and synthesizing succinct and representative human-readable documentation of program interfaces. Our algorithm is based on a combination of path… Show more

Help me understand this report

Search citation statements

Order By: Relevance

Paper Sections

Select...
2
1
1
1

Citation Types

2
83
0

Year Published

2014
2014
2020
2020

Publication Types

Select...
3
3
2

Relationship

0
8

Authors

Journals

citations
Cited by 108 publications
(85 citation statements)
references
References 33 publications
2
83
0
Order By: Relevance
“…This requires developers to obtain knowledge that lies behind the API. Although several problems on API usage examples without adequate documentation or sufficient abstraction have been pointed out in [17], [18], we may leave them unsolved in the paper.…”
Section: Api Usage Patternsmentioning
confidence: 99%
“…This requires developers to obtain knowledge that lies behind the API. Although several problems on API usage examples without adequate documentation or sufficient abstraction have been pointed out in [17], [18], we may leave them unsolved in the paper.…”
Section: Api Usage Patternsmentioning
confidence: 99%
“…There have been several studies which recommend libraries and APIs for developers based on their requirements (e.g., [1,2,3]), and some also find or generate samples to illustrate how to use the recommended APIs (e.g., [4,5,6,7]). However, few studies focus on recommending APIs for Android development.…”
Section: Introductionmentioning
confidence: 99%
“…Such tools have generally focused on automatically generating documentation where none exists [12,13,58,59]. Preliminary studies have focused on very specific classes of incomplete or inconsistent comments (specifically, only for Javadoc elements [55] and less than 30 comments each in large, open source programs [63,64]), but there exists no general approach for identifying low-quality comments of arbitrary types.…”
Section: Ensuring Documentation Completeness and Consistencymentioning
confidence: 99%
“…Studies suggest that only around half of all methods in realworld systems are commented in practice [34]. Several tools have been developed to generate documentation where none exists [12,13,58,59]. While research suggests that up to 34% of existing comments may fail to completely document the associated code, relatively little work has been done to identify or remedy such situations [55].…”
Section: Background and Related Workmentioning
confidence: 99%
See 1 more Smart Citation