Detecting API documentation errors
The DOI matches its Crossref record.
Abstract
When programmers encounter an unfamiliar API library, they often need to refer to its documentations, tutorials, or discussions on development forums to learn its proper usage. These API documents contain valuable information, but may also mislead programmers as they may contain errors (e.g., broken code names and obsolete code samples). Although most API documents are actively maintained and updated, studies show that many new and latent errors do exist. It is tedious and error-prone to find such errors manually as API documents can be enormous with thousands of pages. Existing tools are ineffective in locating documentation errors because traditional natural language (NL) tools do not understand code names and code samples, and traditional code analysis tools do not understand NL sentences. In this paper, we propose the first approach, DOCREF, specifically designed and developed to detect API documentation errors. We formulate a class of inconsistencies to indicate potential documentation errors, and combine NL and code analysis techniques to detect and report such inconsistencies. We have implemented DOCREF and evaluated its effectiveness on the latest documentations of five widely-used API libraries. DOCREF has detected more than 1,000 new documentation errors, which we have reported to the authors. Many of the errors have already been confirmed and fixed, after we reported them.
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
No references could be resolved yet.
Research works printed but not linked: 41
- 10.1109/ICPC.2010.47 · DOI
- 10.1145/1806799.1806855 · DOI · Paper page
- 10.5555/2337223.2337268 · doi:10.5555/2337223.2337268
- 10.1145/1390630.1390664 · DOI · Paper page
- B. Carpenter and B. Baldwin . Text analysis with LingPipe 4 . LingPipe Inc , 2011 . B. Carpenter and B. Baldwin. Text analysis with LingPipe 4. LingPipe Inc, 2011.
- C. E. Chaski . Empirical evaluations of language-based author identification techniques . Forensic Linguistics , 8 : 1 -- 65 , 2001 . C. E. Chaski. Empirical evaluations of language-based author identification techniques. Forensic Linguistics, 8:1--65, 2001.
- 10.1145/1449764.1449790 · DOI · Paper page
- 10.1145/1882291.1882312 · DOI · Paper page
- 10.5555/2337223.2337230 · doi:10.5555/2337223.2337230
- 10.1145/1085313.1085331 · DOI · Paper page
- 10.1109/ICSE.2009.5070532 · DOI
- 10.5555/2337223.2337255 · doi:10.5555/2337223.2337255
- 10.1007/s00766-003-0174-0 · doi:10.1007/s00766-003-0174-0
- 10.2307/815131 · doi:10.2307/815131
- J. Gosling , B. Joy , G. Steele , and G. Bracha . The Java Language Specification , Java SE 7 Edition. 2012 . J. Gosling, B. Joy, G. Steele, and G. Bracha. The Java Language Specification, Java SE 7 Edition. 2012.
- 10.5555/2337223.2337322 · doi:10.5555/2337223.2337322
- 10.1007/978-3-642-03013-0_14 · DOI · Paper page
- 10.1145/2414782.2414783 · DOI
- 10.3115/1075096.1075150 · DOI · Paper page
- 10.1109/RE.2007.38 · doi:10.1109/re.2007.38
- 10.1145/2462456.2464443 · DOI · Paper page
- 10.1109/MS.2003.1241364 · DOI · Paper page
- W. Maalej and M. P. Robillard . Patterns of knowledge in API reference documentation . IEEE Transactions on Software Engineering, to appear. W. Maalej and M. P. Robillard. Patterns of knowledge in API reference documentation. IEEE Transactions on Software Engineering, to appear.
- 10.1109/TSE.2004.1265817 · DOI · Paper page
- 10.1002/spe.v40:7 · doi:10.1002/spe.v40:7
- 10.1145/584955.584976 · DOI · Paper page
- 10.5555/1765931.1765947 · doi:10.5555/1765931.1765947
- 10.5555/2337223.2337319 · doi:10.5555/2337223.2337319
- 10.1109/52.210605 · doi:10.1109/52.210605
- 10.5555/2486788.2486897 · doi:10.5555/2486788.2486897
- 10.1007/s10664-010-9150-8 · DOI · Paper page
- 10.1023/A:1019918908208 · doi:10.1023/a:1019918908208
- 10.1145/1294948.1294952 · DOI
- 10.1145/505282.505283 · DOI · Paper page
- 10.5555/1987434.1987473 · doi:10.5555/1987434.1987473
- N. Synytskyy , J. R. Cordy , and T. R. Dean . Robust multilingual parsing using island grammars . In Proc. CASCON , pages 266 -- 278 , 2003 . N. Synytskyy, J. R. Cordy, and T. R. Dean. Robust multilingual parsing using island grammars. In Proc. CASCON, pages 266--278, 2003.
- 10.1145/1294261.1294276 · DOI · Paper page
- 10.1109/ICST.2012.106 · DOI · Paper page
- 10.1145/2393596.2393608 · doi:10.1145/2393596.2393608
- 10.1007/978-3-642-03013-0_15 · DOI · Paper page
- 10.1109/ASE.2009.94 · DOI · Paper page
Cited by
Smart Contract Development: Challenges and Opportunities
Zou, W., Lo, D., Kochhar, P. S., Le, X.-B. D., Xia, X., Feng, Y., Chen, Z., & Xu, B. (2021) · IEEE Transactions on Software Engineering · doi:10.1109/tse.2019.2942301 · Cited by 727
Tu, Z., Su, Z., & Devanbu, P. (2014) · Proceedings of the 22nd ACM SIGSOFT International Symposium on Foundations of Software Engineering · doi:10.1145/2635868.2635875 · Cited by 238
Self-citationSoftware Documentation Issues Unveiled
Aghajani, E., Nagy, C., Vega-Marquez, O. L., Linares-Vasquez, M., Moreno, L., Bavota, G., & Lanza, M. (2019) · 2019 IEEE/ACM 41st International Conference on Software Engineering (ICSE) · doi:10.1109/icse.2019.00122 · Cited by 195
Semantic similarity metrics for evaluating source code summarization
Haque, S., Eberhart, Z., Bansal, A., & McMillan, C. (2022) · Proceedings of the 30th IEEE/ACM International Conference on Program Comprehension · doi:10.1145/3524610.3527909 · Cited by 116
“Yet, while programmers seek good documentation for themselves, they are notorious for writing poor documentation for others due to time pressure and language barriers [1, 2].”
BackgroundA Survey on Online Learning Preferences for Computer Science and Programming
Escobar-Avila, J., Venuti, D., Di Penta, M., & Haiduc, S. (2019) · 2019 IEEE/ACM 41st International Conference on Software Engineering: Software Engineering Education and Training (ICSE-SEET) · doi:10.1109/icse-seet.2019.00026 · Cited by 24
Metadata
- Authors
- Zhong, H., & Su, Z.
- Venue
- Proceedings of the 2013 ACM SIGPLAN international conference on Object oriented programming systems languages & applications
- Publisher
- ACM
- Published
- 2013-10-29
- Pages
- 803-816
- OpenAlex
- W2166069603
- Cited by
- 80
- References
- 0
- FWCI
- 4.57
- Type
- conference paper
- Language
- en
- Open access
- closed
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: Detecting API documentation errors. https://app.cochat.ai/papers/10.1145/2509136.2509523
- The paper
- Zhong, H., & Su, Z. (2013). Detecting API documentation errors. Proceedings of the 2013 ACM SIGPLAN international conference on Object oriented programming systems languages & applications. https://doi.org/10.1145/2509136.2509523
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.