What Should Developers Be Aware Of? An Empirical Study on the Directives of API Documentation
arXiv:1205.6363 · doi:10.1007/s10664-011-9186-4
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.
Empirical Software Engineering (2011)
Cited by in corpus (6)
- A Decade of Code Comment Quality Assessment: A Systematic Literature Review
- On Using Machine Learning to Identify Knowledge in API Reference Documentation
- Mining Software Components from Object-Oriented APIs
- An Empirical Study of API Misuses of Data-Centric Libraries
- Characterising the Knowledge about Primitive Variables in Java Code Comments
- What the Fix? A Study of ASATs Rule Documentation