Home > Research > Publications & Outputs > What should developers be aware of?
View graph of relations

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

Research output: Contribution to Journal/MagazineJournal articlepeer-review

Published

Standard

What should developers be aware of? an empirical study on the directives of API documentation. / Monperrus, Martin; Eichberg, Michael; Tekes, Elif et al.
In: Empirical Software Engineering, Vol. 17, No. 6, 01.12.2012, p. 703-737.

Research output: Contribution to Journal/MagazineJournal articlepeer-review

Harvard

Monperrus, M, Eichberg, M, Tekes, E & Mezini, M 2012, 'What should developers be aware of? an empirical study on the directives of API documentation', Empirical Software Engineering, vol. 17, no. 6, pp. 703-737. https://doi.org/10.1007/s10664-011-9186-4

APA

Vancouver

Monperrus M, Eichberg M, Tekes E, Mezini M. What should developers be aware of? an empirical study on the directives of API documentation. Empirical Software Engineering. 2012 Dec 1;17(6):703-737. doi: 10.1007/s10664-011-9186-4

Author

Monperrus, Martin ; Eichberg, Michael ; Tekes, Elif et al. / What should developers be aware of? an empirical study on the directives of API documentation. In: Empirical Software Engineering. 2012 ; Vol. 17, No. 6. pp. 703-737.

Bibtex

@article{17e42fcf53414110869fa48cdd1c55c6,
title = "What should developers be aware of?: an empirical study on the directives of API documentation",
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.",
author = "Martin Monperrus and Michael Eichberg and Elif Tekes and Mira Mezini",
year = "2012",
month = dec,
day = "1",
doi = "10.1007/s10664-011-9186-4",
language = "English",
volume = "17",
pages = "703--737",
journal = "Empirical Software Engineering",
issn = "1382-3256",
publisher = "Springer Netherlands",
number = "6",

}

RIS

TY - JOUR

T1 - What should developers be aware of?

T2 - an empirical study on the directives of API documentation

AU - Monperrus, Martin

AU - Eichberg, Michael

AU - Tekes, Elif

AU - Mezini, Mira

PY - 2012/12/1

Y1 - 2012/12/1

N2 - 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.

AB - 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.

U2 - 10.1007/s10664-011-9186-4

DO - 10.1007/s10664-011-9186-4

M3 - Journal article

VL - 17

SP - 703

EP - 737

JO - Empirical Software Engineering

JF - Empirical Software Engineering

SN - 1382-3256

IS - 6

ER -