JavaDoc Pro

Advanced JavaDoc generation, validation, and maintenance for Spring Boot, Maven, and plain Java projects — with AI-assisted writing, coverage metrics, lint rules, and architecture-aware comments, all built natively into VS Code.

JavaDoc Pro goes beyond what Eclipse's built-in generator or other Java IDEs offer: it reads your Spring annotations and produces documentation that actually reflects what your code does (HTTP routes, persistence mappings, transactional behavior) instead of generic placeholder text, and it stays useful long after the first pass — catching stale @param tags, missing @throws, and broken {@link} references as your code evolves.

Highlights

• Spring-aware generation — controllers get HTTP method/path/status-code documentation, repositories get JPA entity cross-references, @Transactional/@Async/@Cacheable/@Scheduled methods get behavioral notes, all derived deterministically from annotations already in your code.
• Four generation modes — template, heuristic (zero-network, pattern-based prose), ai (calls Anthropic, OpenAI, Azure OpenAI, or any OpenAI-compatible endpoint), and hybrid (heuristic backbone with AI enhancement and automatic fallback if the AI call fails).
• A resilient parser — a hand-written, dependency-free Java tokenizer/parser that never throws; malformed or partial code degrades gracefully instead of blocking generation.
• 16 built-in lint rules covering missing tags, mismatched @param names/order, stale signatures, broken {@link}/@see references, unescaped HTML, and more — each independently configurable to error/warning/info/hint/off.
• Live coverage and lint dashboards in the activity bar: Coverage Explorer, Lint Diagnostics, Missing Documentation, and Spring Boot Components, all backed by a single shared workspace scan.
• CI-ready quality gate — one command computes coverage and lint-error counts and writes a machine-readable verdict your build pipeline can parse.
• Security-conscious AI integration — API keys live exclusively in VS Code's encrypted Secret Storage, never in settings.json, entered through a dedicated Settings Panel.

Getting Started

1. Open a Java/Maven/Gradle/Spring Boot workspace.
2. Run JavaDoc Pro: Generate JavaDoc for Workspace (Command Palette) for a first pass, or Generate JavaDoc for Current File to start smaller.
3. Open the JavaDoc Pro activity bar icon to review coverage, outstanding lint issues, and Spring component classification.
4. Run the Getting Started with JavaDoc Pro walkthrough (Command Palette → "Open Walkthrough") for an interactive tour.

All workspace-wide generation is batched into a single WorkspaceEdit, so Ctrl+Z / Cmd+Z reverts the entire pass at once.

Commands

Activity Bar Views

• Coverage Explorer — workspace → file → member drill-down with documented/total percentages.
• Lint Diagnostics — rule violations grouped by file, with one-click fixes on fixable issues.
• Missing Documentation — a flat checklist of every undocumented public member.
• Spring Boot Components — every detected @RestController, @Service, @Repository, @Entity, @Configuration, and @SpringBootApplication class, grouped by role.

Configuration

All settings live under the javadocPro.* namespace in settings.json; see the Settings UI for descriptions and defaults. Key groups:

• javadocPro.author.*, javadocPro.tags.* — author resolution (git config or fixed name) and which tags to include.
• javadocPro.style.* — wrap length, tag alignment, markdown vs HTML lists.
• javadocPro.generation.* — mode (template/heuristic/ai/hybrid), overwrite behavior, on-save action.
• javadocPro.spring.* — toggles for annotation awareness, HTTP status inference, @apiNote generation.
• javadocPro.validation.* — on-type linting, debounce, per-rule severities, minimum coverage threshold.
• javadocPro.ai.* — provider, model, temperature, context window, response caching, review-before-insert.
• javadocPro.ui.* — status bar coverage, inlay hints, outdated decorations, gutter icons.
• javadocPro.advanced.* — exclude globs, custom tags, .editorconfig respect.

Teams can also commit a project-level .javadocpro.json file (schema-validated) to share settings via source control independent of individual settings.json files.

AI Providers

Set javadocPro.ai.provider to anthropic, openai, azureOpenAI, or custom, then open JavaDoc Pro: Open Settings Panel to paste in an API key. Keys are written directly to VS Code's encrypted Secret Storage via context.secrets and are never persisted in any settings file. When javadocPro.ai.requireReviewBeforeInsert is enabled, AI-generated suggestions appear as CodeLens actions ("✓ Accept" / "✗ Reject") above the affected declaration instead of being inserted automatically.

Architecture Notes

• Parser: src/parsers/heuristicJavaParser.ts is a hand-written tokenizer and recursive-descent-style parser — no ANTLR or external Java grammar dependency. It never throws; structural anomalies are recorded as warnings and parsing continues on a best-effort basis.
• Generation pipeline: src/generators/javadocGenerator.ts orchestrates heuristic generation, optional AI enhancement (with automatic fallback on any failure), Spring-aware tag/paragraph injection, and final text formatting — all pure functions over the parsed AST, independent of the editor APIs.
• Editing: src/services/editPlanner.ts is the only place that turns generation results into actual vscode.WorkspaceEdit operations, centralizing the "don't clobber existing non-empty JavaDoc" rule.
• Shared report cache: src/services/workspaceReportCache.ts scans the workspace once and feeds the four tree views, the status bar, the coverage report, and the quality gate from a single snapshot.

Development

npm install
npm run watch       # webpack --watch, for live development
npm run lint         # eslint
npm run test:unit    # pure unit tests (no extension host required)
npm test             # full extension-host integration tests

Press F5 in VS Code (with this folder open) to launch an Extension Development Host with JavaDoc Pro loaded.

License

MIT — see LICENSE.