170-java-documentation

An interactive guide for creating or improving documentation in Java projects, including README files, package descriptions, and Javadoc comments. Javadoc is Java's standard format for documenting code and its parameters, results, and errors.

In plain words
What is it for?
Use it to document single- or multi-module Maven projects, add package-info.java files, improve Javadoc tags, choose how existing files are handled, and validate the result.
Why use it?
It gives documentation work a defined sequence and checks the project before making changes. This helps avoid generating documentation on a project that already fails validation.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/jabrena/cursor-rules-examples/170-java-documentation
Any agent
npx skills add jabrena/cursor-rules-examples --skill 170-java-documentation
Clone the repo
git clone --depth 1 https://github.com/jabrena/cursor-rules-examples

Made for: Claude Code, Codex.

Per session 56 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 397 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00056 $0.00397
Opus 5 $0.00028 $0.00198
Sonnet 5 $0.00011 $0.00079
Haiku 4.5 $0.00006 $0.00040

Measured yesterday against content hash 9ee3a132b2f5, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

170-java-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.agents/skills/170-java-documentation/SKILL.md · 37 lines

What it actually says

Java Documentation Generator with modular step-based configuration

Generate comprehensive Java project documentation through a modular, step-based interactive process that covers README.md, package-info.java, and Javadoc. This is an interactive SKILL.

What is covered in this Skill?

  • README.md generation for single-module and multi-module Maven projects
  • package-info.java creation with basic/detailed/minimal documentation levels
  • Javadoc enhancement: comprehensive @param/@return/@throws tags
  • File handling strategies: overwrite/add/backup/skip
  • Final documentation validation with ./mvnw clean compile and ./mvnw javadoc:javadoc

Constraints

Before applying any documentation generation, ensure the project validates. If validation fails, stop immediately — do not proceed until all validation errors are resolved.

  • MANDATORY: Run ./mvnw validate or mvn validate before applying any documentation generation
  • SAFETY: If validation fails, stop immediately — do not proceed until all validation errors are resolved
  • BEFORE APPLYING: Read the reference for detailed good/bad examples, constraints, and safeguards for each documentation generation pattern

When to use this skill

  • Review Java code for documentation
  • Apply best practices for documentation in Java code

Reference

For detailed guidance, examples, and constraints, see references/170-java-documentation.md.

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 37 lines · 56 tokens per session scan A 9ee3a132b2f5

Subscribe to this mod's changes

170-java-documentation is a skill published in the GitHub repository jabrena/cursor-rules-examples (2 stars, last pushed 5d ago), licensed Apache-2.0. It adds 56 tokens to every session and 397 once invoked, about $0.0003 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.

Related

Other skills, from other repositories

complexity

Wire and satisfy cyclomatic complexity lint. Detect the repo's existing linter, set or keep a cap (default 10), extract until green, never disable the rule. Use when complexity.mdc globs match, lint reports C901/complexity, or the user asks for simpler / less nested code.

kleosr/kleosrules · 66 tokens

uikit-expert

Write, review, or improve UIKit code following best practices for view controller lifecycle, Auto Layout, collection views, navigation, animation, memory management, and modern iOS 18–26 APIs. Use when building new UIKit features, refactoring existing views or view controllers, reviewing code quality, adopting modern…

zinxj/uikit-expert-skill · 95 tokens

debugging

Debugs difficult, intermittent, cross-layer, or regression bugs evidence before fixes. Use when the cause is unknown, normal debugging stalled, or the user asks to hunt, diagnose, or root-cause a bug.

kleosr/kleosrules · 46 tokens

redesign-existing-projects

Elaya audit for existing sites/apps that look generic, cheap, or AI-made. Diagnose first, then fix in place (fonts, color, states, layout, motion). Use when Mario says polish, audit, upgrade, or it looks horrible. Product apps apply diagnosis through premium-ui-craft values, not Elaya black/Geist/700ms. Upstream…

kleosr/kleosrules · 92 tokens

testing

Test writing workflows: TDD order, mocks, house gauntlet, regression naming. Use when writing/editing tests or when testing.mdc globs match. Thin rule = roofs; this skill = procedure.

kleosr/kleosrules · 45 tokens

design-stack

Router for Mario's Design agent. Picks one UI skill plus premium-ui-craft. Use at the start of any Product Designer / @Design / UX/UI turn.

kleosr/kleosrules · 36 tokens