Please use this identifier to cite or link to this item: https://doi.org/10.21256/zhaw-3218
Publication type: Article in scientific journal
Type of review: Peer review (publication)
Title: Automatic detection and repair recommendation of directive defects in Java API documentation
Authors: Zhou, Yu
Yan, Xin
Chen, Taolue
Panichella, Sebastiano
Gall, Harald
DOI: 10.1109/TSE.2018.2872971
10.21256/zhaw-3218
Published in: IEEE Transactions on Software Engineering
Volume(Issue): 46
Issue: 9
Pages: 1004
Pages to: 1023
Issue Date: 2018
Publisher / Ed. Institution: IEEE
ISSN: 0098-5589
1939-3520
Language: English
Subject (DDC): 005: Computer programming, programs and data
Abstract: Application Programming Interfaces (APIs) represent key tools for software developers to build complex software systems. However, several studies have revealed that even major API providers tend to have incomplete or inconsistent API documentation. This can severely hamper the API comprehension and, as a consequence, the quality of the software built on them. In this paper, we propose DRONE (Detect and Repair of dOcumentatioN dEfects), a framework to automatically detect and repair defects from API documents by leveraging techniques from program analysis, natural language processing, and constraint solving. Specifically, we target at the directives of API documents, which are related to parameter constraints and exception handling declarations. Furthermore, in presence of defects, we also provide a prototypical repair recommendation system. We evaluate our approach on parts of the well-documented APIs of JDK 1.8 APIs (including javaFX) and Android 7.0 (level 24). Across the two empirical studies, our approach can detect API defects with an average F-measure of 79.9%, 71.7%, and 81.4%, respectively. The API repairing capability has also been evaluated on the generated recommendations in a further experiment. User judgments indicate that the constraint information is addressed correctly and concisely in the rendered directives.
URI: https://digitalcollection.zhaw.ch/handle/11475/17312
Fulltext version: Accepted version
License (according to publishing contract): Licence according to publishing contract
Departement: School of Engineering
Organisational Unit: Institute of Applied Information Technology (InIT)
Appears in Collections:Publikationen School of Engineering

Files in This Item:
File Description SizeFormat 
tse18.pdfAccepted Version1.53 MBAdobe PDFThumbnail
View/Open


Items in DSpace are protected by copyright, with all rights reserved, unless otherwise indicated.