A Systematic Mapping Study on Tools for API Documentation Generation

D4 Published development or research report or study


Internal Authors/Editors


Publication Details

List of Authors: Kristian Nybom, Adnan Ashraf, Ivan Porres
Publisher: Turku Centre for Computer Science (TUCS)
Place: Turku
Publication year: 2017
Start page: 1
End page: 22
eISBN: 978-952-12-3556-6


Abstract

Background: Application Programming Interfaces (APIs) are key to software reuse. Software developers can link functionality and behavior found in other software with their own software by taking an API into use. However, figuring out how an API works is usually demanding, and may require that the developers spend a notable amount of time familiarizing themselves with the API. Good API documentation is of key importance for simplifying this task.

Objective: To present a comprehensive, unbiased overview of the state-of-the-art on tools and approaches for API documentation generation.

Method: A systematic mapping study on published tools and approaches that can be used for generating API documentation, or for assisting in the API documentation process.

Results: 42 studies on API documentation generation tools and approaches analyzed and categorized in a variety of ways. Among other things, the report presents an overview of what kind of tools have been developed, what kind of documentation they generate, and what sources the documentation approaches require.

Conclusion: Out of the identified approaches, many contribute to API documentation in the areas of natural language documentation and code examples. Many of the approaches contribute to the accuracy and correctness of API documentation, but also to ease developers understanding of the documentation. Most of the approaches are automatic, simplifying the API documentation generation notably, under the assumption that relevant sources for the generation are available. Most of the API documentation approaches are evaluated either by execution of the approach followed by analysis of the results, or by empirical evaluation methods.


Documents


Last updated on 2019-22-10 at 03:26