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

@article{Martin2011WhatSD,
  title={What should developers be aware of? An empirical study on the directives of API documentation},
  author={Monperrus Martin and M. Eichberg and Elif Tekes and M. Mezini},
  journal={Empirical Software Engineering},
  year={2011},
  volume={17},
  pages={703-737}
}
  • Monperrus Martin, M. Eichberg, +1 author M. Mezini
  • Published 2011
  • Computer Science
  • Empirical Software Engineering
  • 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… CONTINUE READING
    56 Citations

    Figures, Tables, and Topics from this paper.

    An observational study on API usage constraints and their documentation
    • M. Saied, H. Sahraoui, B. Dufour
    • Computer Science
    • 2015 IEEE 22nd International Conference on Software Analysis, Evolution, and Reengineering (SANER)
    • 2015
    • 22
    • Highly Influenced
    • PDF
    Patterns of Knowledge in API Reference Documentation
    • 98
    • PDF
    Inferring API Usage Patterns and Constraints : a Holistic Approach
    Analyzing APIs Documentation and Code to Detect Directive Defects
    • 53
    • PDF
    DRONE: A Tool to Detect and Repair Directive Defects in Java APIs Documentation
    • 1
    • PDF
    An empirical study on API parameter rules
    Automatic Detection and Repair Recommendation of Directive Defects in Java API Documentation
    • 4
    • PDF

    References

    SHOWING 1-10 OF 54 REFERENCES
    Mining subclassing directives to improve framework reuse
    • 23
    • PDF
    API documentation from source code comments: a case study of Javadoc
    • 125
    • Highly Influential
    Improving API documentation usability with knowledge pushing
    • 112
    • PDF
    An Empirical Study on Evolution of API Documentation
    • 48
    • PDF
    What Makes APIs Hard to Learn? Answers from Developers
    • 254
    • Highly Influential
    • PDF
    Inferring Resource Specifications from Natural Language API Documentation
    • 154
    • PDF
    A case study of API redesign for improved usability
    • 43
    • PDF
    Increasing awareness of delocalized information to facilitate API usage
    • 5
    • PDF
    Improving software API usability through text analysis: A case study
    • R. B. Watson
    • Computer Science
    • 2009 IEEE International Professional Communication Conference
    • 2009
    • 11
    • PDF
    The Factory Pattern in API Design: A Usability Evaluation
    • 150
    • PDF