Automatic Detection and Repair Recommendation of Directive Defects in Java API Documentation
Open accessThe DOI matches its Crossref record; 5 of the 5 references it cites were found in a registry or an index.
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 percent, 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.
Overview
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Self-check
Percentages, sums and reported differences re-computed from the paper’s own numbers.
The self-check needs the paper’s full text.
Citations
Cites
TnT: a statistical part-of-speech tagger
Brants, T. (2000) · Proceedings of the sixth conference on Applied natural language processing - · doi:10.3115/974147.974178 · Cited by 1,329
Towards automatically generating summary comments for Java methods
Sridhara, G., Hill, E., Muppaneni, D., Pollock, L., & Vijay-Shanker, K. (2010) · Proceedings of the IEEE/ACM international conference on Automated software engineering · doi:10.1145/1858996.1859006 · Cited by 514 · cited 1×
“previous work [29], [32], [33], [34], we primarily consider three aspects, i.”
BackgroundThe relevance of software documentation, tools and technologies: a survey
Forward, A., & Lethbridge, T. C. (2002) · Proceedings of the 2002 ACM symposium on Document engineering · doi:10.1145/585058.585065 · Cited by 268 · cited 1×
“In most cases, these implicit exceptions are caused by programming errors, so it might be inappropriate to include them in the documentation [36].”
BackgroundHow do API changes trigger stack overflow discussions? a study on the Android SDK
Linares-Vásquez, M., Bavota, G., Di Penta, M., Oliveto, R., & Poshyvanyk, D. (2014) · Proceedings of the 22nd International Conference on Program Comprehension · doi:10.1145/2597008.2597155 · Cited by 146
What help do developers seek, when and how?
Li, H., Xing, Z., Peng, X., & Zhao, W. (2013) · 2013 20th Working Conference on Reverse Engineering (WCRE) · doi:10.1109/wcre.2013.6671289 · Cited by 81
Cited by
DocTer: documentation-guided fuzzing for testing deep learning API functions
Xie, D., Li, Y., Kim, M., Pham, H. V., Tan, L., Zhang, X., & Godfrey, M. W. (2022) · Proceedings of the 31st ACM SIGSOFT International Symposium on Software Testing and Analysis · doi:10.1145/3533767.3534220 · Cited by 81
Predictive Comment Updating With Heuristics and AST-Path-Based Neural Learning: A Two-Phase Approach
Lin, B., Wang, S., Liu, Z., Xia, X., & Mao, X. (2023) · IEEE Transactions on Software Engineering · doi:10.1109/tse.2022.3185458 · Cited by 27
“DRONE [33], the detection and repair tool for API documentation defects, may also be used to recommend updates to specific types of old comments despite that its generality to code comments remains unknown.”
MethodDetecting outdated code element references in software repository documentation
Tan, W. S., Wagner, M., & Treude, C. (2024) · Empirical Software Engineering · doi:10.1007/s10664-023-10397-6 · Cited by 13
Metadata
- Authors
- Zhou, Y., Wang, C., Yan, X., Chen, T., Panichella, S., & Gall, H.
- Venue
- IEEE Transactions on Software Engineering
- Published
- 2020-09-01
- Volume
- 46
- Issue
- 9
- Pages
- 1004-1023
- ISSN
- 0098-5589 (ISSN-L)
- 1939-3520
- 2326-3881
- OpenAlex
- W2915560446
- Cited by
- 51
- References
- 5
- FWCI
- 8.37
- Type
- journal article
- Language
- en
- Open access
- green
About these checks
Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.
Statistics and arithmetic are recomputed, not judged.
Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.
What counts as a claim ›How we measure confidence ›How we check this ›
Are you an author, or do you see a problem with this page? Request a review
How to cite
Cite CoChat for the checks on this page, and the paper for its own findings.
- This page
- CoChat. (2026). Citation check: Automatic Detection and Repair Recommendation of Directive Defects in Java API Documentation. https://app.cochat.ai/papers/10.1109/tse.2018.2872971
- The paper
- Zhou, Y., Wang, C., Yan, X., Chen, T., Panichella, S., & Gall, H. (2020). Automatic Detection and Repair Recommendation of Directive Defects in Java API Documentation. IEEE Transactions on Software Engineering. https://doi.org/10.1109/tse.2018.2872971
Data sources
Bibliographic data: Semantic Scholar, OpenAlex, Crossref.
Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).
Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.