What should developers be aware of? An empirical study on the directives of API documentation

  • Authors:
  • Martin Monperrus;Michael Eichberg;Elif Tekes;Mira Mezini

  • Affiliations:
  • ADAM, University of Lille, Villeneuve d'Ascq Cedex, France 59655;Software Technology Group, Darmstadt University of Technology, Hochschulstr. 10, Germany 64289;PSI Logistics GmBh, Aschaffenburg, Germany 63741;Software Technology Group, Darmstadt University of Technology, Hochschulstr. 10, Germany 64289

  • Venue:
  • Empirical Software Engineering
  • Year:
  • 2012

Quantified Score

Hi-index 0.00

Visualization

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.