research-article

DRONE: a tool to detect and repair directive defects in Java APIs documentation

Authors:

Sebastiano Panichella,

Harald GallAuthors Info & Claims

ICSE '19: Proceedings of the 41st International Conference on Software Engineering: Companion Proceedings

Pages 115 - 118

https://doi.org/10.1109/ICSE-Companion.2019.00052

Published: 25 May 2019 Publication History

Abstract

Application programming interfaces (APIs) documentation is the official reference of the APIs. Defects in API documentation pose serious hurdles to their comprehension and usage. In this paper, we present DRONE, a tool that can automatically detect the directive defects in APIs documents and recommend repair solutions to fix them. Particularly, DRONE focuses on four defect types related to parameter usage constraints. To achieve this, DRONE leverages techniques from static program analysis, natural language processing and logic reasoning. The implementation is based on the Eclipse-plugin architecture, which provides an integrated user interface. Extensive experiments demonstrate the efficacy of the tool.

Demo webpage: https://goo.gl/BmEKic

Demo video: https://youtu.be/NDPXiapxoMk

References

[1]

G. Uddin and M. P. Robillard, "How api documentation fails," Software, IEEE, vol. 32, no. 4, pp. 68--75, 2015.

Digital Library

[2]

M. A. Saied, H. Sahraoui, and B. Dufour, "An observational study on api usage constraints and their documentation," in (SANER 2015). IEEE, 2015, pp. 33--42.

[3]

M. Monperrus, M. Eichberg, E. Tekes, and M. Mezini, "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, 2012.

Digital Library

[4]

Y. Zhou, R. Gu, T. Chen, Z. Huang, S. Panichella, and H. C. Gall, "Analyzing apis documentation and code to detect directive defects," in Proceedings of the 39th International Conference on Software Engineering, ICSE 2017, 2017, pp. 27--37.

Digital Library

[5]

Y. Zhou, C. Wang, X. Yan, T. Chen, S. Panichella, and H. C. Gall, "Automatic detection and repair of directive defects of java APIs documentation," IEEE Transactions on Software Engineering, To appear.

[6]

A. D. Sorbo, S. Panichella, C. A. Visaggio, M. D. Penta, G. Canfora, and H. C. Gall, "Development emails content analyzer: Intention mining in developer discussions," in ASE 2015. IEEE, 2015, pp. 12--23.

Digital Library

[7]

S. Panichella, A. Panichella, M. Beller, A. Zaidman, and H. C. Gall, "The impact of test case summaries on bug fixing performance: an empirical investigation," in International Conference on Software Engineering, ICSE 2016, 2016, pp. 547--558.

Digital Library

[8]

P. W. McBurney and C. McMillan, "Automatic documentation generation via source code summarization of method context," in Proceedings of the 22nd International Conference on Program Comprehension. ACM, 2014, pp. 279--290.

Digital Library

[9]

L. Shi, H. Zhong, T. Xie, and M. Li, "An empirical study on evolution of api documentation." in FASE, vol. 6603. Springer, 2011, pp. 416--431.

Digital Library

[10]

B. Dagenais and M. P. Robillard, "Creating and evolving developer documentation: understanding the decisions of open source contributors," in SIGSOFT international symposium on Foundations of software engineering. ACM, 2010, pp. 127--136.

Digital Library

[11]

S. Liu, J. Sun, Y. Liu, Y. Zhang, B. Wadhwa, J. S. Dong, and X. Wang, "Automatic early defects detection in use case documents," in International conference on Automated software engineering. ACM, 2014, pp. 785--790.

Digital Library

[12]

R. P. Buse and W. R. Weimer, "Automatic documentation inference for exceptions," in Proceedings of the 2008 international symposium on Software testing and analysis. ACM, 2008, pp. 273--282.

Digital Library

[13]

S. H. Tan, D. Marinov, L. Tan, and G. T. Leavens, "@tcomment: Testing javadoc comments to detect comment-code inconsistencies," in (ICST 2012). IEEE, 2012, pp. 260--269.

Digital Library

[14]

H. Zhong and Z. Su, "Detecting api documentation errors," in ACM SIGPLAN Notices, vol. 48, no. 10. ACM, 2013, pp. 803--816.

Digital Library

[15]

S. Panichella, "Summarization techniques for code, change, testing, and user feedback (invited paper)," in Workshop on Validation, Analysis and Evolution of Software Tests, VST@SANER 2018, 2018, pp. 1--5.

[16]

A. Blasi and A. Gorla, "Replicomment: identifying clones in code comments," in ICPC 2018. ACM, 2018, pp. 320--323.

Digital Library

Cited By

Izadi MAhmadabadi MSorbo APanichella S(2022)On the evaluation of NLP-based models for software engineeringProceedings of the 1st International Workshop on Natural Language-based Software Engineering10.1145/3528588.3528665(48-50)Online publication date: 21-May-2022
https://dl.acm.org/doi/10.1145/3528588.3528665
Treude CMiddleton JAtapattu TDevanbu PCohen MZimmermann T(2020)Beyond accuracy: assessing software documentation qualityProceedings of the 28th ACM Joint Meeting on European Software Engineering Conference and Symposium on the Foundations of Software Engineering10.1145/3368089.3417045(1509-1512)Online publication date: 8-Nov-2020
https://dl.acm.org/doi/10.1145/3368089.3417045

Recommendations

Analyzing APIs documentation and code to detect directive defects
ICSE '17: Proceedings of the 39th International Conference on Software Engineering

Application Programming Interface (API) documents represent one of the most important references for API users. However, it is frequently reported that the documentation is inconsistent with the source code and deviates from the API itself. Such ...
An Empirical Comparison Between Tutorials and Crowd Documentation of Application Programming Interface
Abstract
API (application programming interface) documentation is critical for developers to learn APIs. However, it is unclear whether API documentation indeed improves the API learnability for developers. In this paper, we focus on two types of API ...
Tool support for crosscutting concerns of API documentation
AOSD '10: Proceedings of the 9th International Conference on Aspect-Oriented Software Development

Writing detailed API (Application Programming Interface) documentation is a significant task for developing a good class library or framework. However, existing documentation tools such as Javadoc provide only limited support and thus the description ...

Comments

Information & Contributors

Information

Published In

cover image ACM Conferences

ICSE '19: Proceedings of the 41st International Conference on Software Engineering: Companion Proceedings

May 2019

369 pages

Conference Chair:
Gunter Mussbacher
McGill University, Canada
,
General Chair:
Joanne M. Atlee
University of Waterloo, Canada
,
Program Chair:
Tevfik Bultan
University of California, Santa Barbara

Sponsors

SIGSOFT: ACM Special Interest Group on Software Engineering
IEEE-CS: Computer Society

Publisher

IEEE Press

Publication History

Published: 25 May 2019

Check for updates

Author Tags

Qualifiers

Research-article

Conference

ICSE '19

Sponsor:

SIGSOFT
IEEE-CS

ICSE '19: 41st International Conference on Software Engineering

May 25 - 31, 2019

Quebec, Montreal, Canada

Acceptance Rates

Overall Acceptance Rate 276 of 1,856 submissions, 15%

Upcoming Conference

ICSE 2025

2025 IEEE/ACM 46th International Conference on Software Engineering

April 26 - May 3, 2025

Ottawa , ON , Canada

Contributors

Other Metrics

View Article Metrics

Bibliometrics & Citations

Bibliometrics

Article Metrics

2
Total Citations
View Citations
59
Total Downloads

Downloads (Last 12 months)3
Downloads (Last 6 weeks)0

Reflects downloads up to 14 Sep 2024

Other Metrics

View Author Metrics

Citations

Cited By

Izadi MAhmadabadi MSorbo APanichella S(2022)On the evaluation of NLP-based models for software engineeringProceedings of the 1st International Workshop on Natural Language-based Software Engineering10.1145/3528588.3528665(48-50)Online publication date: 21-May-2022
https://dl.acm.org/doi/10.1145/3528588.3528665
Treude CMiddleton JAtapattu TDevanbu PCohen MZimmermann T(2020)Beyond accuracy: assessing software documentation qualityProceedings of the 28th ACM Joint Meeting on European Software Engineering Conference and Symposium on the Foundations of Software Engineering10.1145/3368089.3417045(1509-1512)Online publication date: 8-Nov-2020
https://dl.acm.org/doi/10.1145/3368089.3417045

View Options

Get Access

Login options

Check if you have access through your login credentials or your institution to get full access on this article.

Full Access

Get this Publication

View options

PDF

View or Download as a PDF file.

eReader

View online with eReader.

Media

Figures

Other

Tables

View Table of Contents