English

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

Software Engineering 2021-11-12 v1

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.

Keywords

Cite

@article{arxiv.1205.6363,
  title  = {What Should Developers Be Aware Of? An Empirical Study on the Directives of API Documentation},
  author = {Martin Monperrus and Michael Eichberg and Elif Tekes and Mira Mezini},
  journal= {arXiv preprint arXiv:1205.6363},
  year   = {2021}
}

Comments

Empirical Software Engineering (2011)