TU Darmstadt / ULB / TUbiblio

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

Monperrus, Martin and Eichberg, Michael and Tekes, Elif and Mezini, Mira (2012):
What should developers be aware of? An empirical study on the directives of API documentation.
In: Empirical Software Engineering, Springer Netherlands, pp. 1-35, ISSN 1382-3256, [Online-Edition: http://dx.doi.org/10.1007/s10664-011-9186-4],
[Article]

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.

Item Type: Article
Erschienen: 2012
Creators: Monperrus, Martin and Eichberg, Michael and Tekes, Elif and Mezini, Mira
Title: What should developers be aware of? An empirical study on the directives of API documentation
Language: English
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.

Journal or Publication Title: Empirical Software Engineering
Publisher: Springer Netherlands
Divisions: 20 Department of Computer Science > Software Technology
20 Department of Computer Science
Date Deposited: 15 Feb 2012 14:14
Official URL: http://dx.doi.org/10.1007/s10664-011-9186-4
Identification Number: doi:10.1007/s10664-011-9186-4
Export:

Optionen (nur für Redakteure)

View Item View Item