javalangrefCleaner

javalangrefCleaner is an open-source command-line tool designed to clean and standardize references to Java language elements in code comments, documentation, and sample code. It analyzes Java source files and related texts to identify references to classes, methods, fields, and packages, then validates them against the Java Language Specification (JLS) and official API references.

The tool can fix common inconsistencies, flag deprecated or renamed API elements, and suggest updated fully-qualified names. It operates in two modes: a non-destructive validation pass that reports issues, and an automatic fixer that applies changes in place or outputs a patch file for review. Configuration is provided via a lightweight descriptor that maps terms and specifies preferred reference styles.

Built to integrate with continuous integration pipelines, javalangrefCleaner can parse and process large codebases efficiently and supports incremental checks to minimize noise. It also supports custom reference indexes, allowing teams to onboard internal libraries or vendor APIs alongside the public Java API surface.

The project is maintained as an open-source initiative with a permissive license and an active contributor community. Documentation and source code are hosted in a public repository, inviting issues, pull requests, and discussions.

See also: Java Language Specification, Java API, documentation tooling, and code quality linters.