What Should Developers Be Aware Of? An Empirical Study on the Directives of API Documentation

by Martin Monperrus, Michael Eichberg, Elif Tekes and Mira Mezini
Abstract: Application Programming Interfaces (API) are exposed to developers in order to reuse software libraries. API directives are natural-language statements in API documentation that make developers aware of constraints and guidelines related to the usage of an API. This paper presents the design and the results of an empirical study on the directives of API documentation of object-oriented libraries. Its main contribution is to propose and extensively discuss a taxonomy of 23 kinds of API directives.
 View PDF
Open-access (on archives-ouvertes.fr)
Publisher version (via DOI)
Citations: [citations]
Other publications of Martin Monperrus

Cite it:

What Should Developers Be Aware Of? An Empirical Study on the Directives of API Documentation (, , and ), In Empirical Software Engineering, Springer Verlag, volume 17, .
Martin Monperrus, Michael Eichberg, Elif Tekes and Mira Mezini, "What Should Developers Be Aware Of? An Empirical Study on the Directives of API Documentation", In Empirical Software Engineering, Springer Verlag, vol. 17, no. 6, pp. 703-737, 2012.

Bibtex Entry:

@article{Monperrus2011a,
 title = {{What Should Developers Be Aware Of? An Empirical Study on the Directives of API Documentation}},
 author = {Monperrus, Martin and Eichberg, Michael and Tekes, Elif and Mezini, Mira},
 url = {https://hal.inria.fr/hal-00702183/file/article.pdf},
 journal = {{Empirical Software Engineering}},
 publisher = {{Springer Verlag}},
 volume = {17},
 number = {6},
 pages = {703-737},
 year = {2012},
 doi = {10.1007/s10664-011-9186-4},
}
Powered by bibtexbrowser
Tagged as: