170-java-documentation

170-java-documentation is a skill for Claude Code, Codex from jabrena/plinth. It costs 95 tokens per session (640 once invoked), scanned A, original, Apache-2.0.

A Java documentation workflow for creating or improving README files, package descriptions, and Javadoc. Javadoc is Java's built-in 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 Javadoc tags, and generate documentation output.
Why use it?
It makes project setup and code usage easier to understand and provides validation before and after documentation changes.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to document single- or multi-module Maven projects, add Javadoc tags, and generate documentation output.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/jabrena/plinth/170-java-documentation
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.

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

Made for: Claude Code, Codex.

Its marketplace also offers this one on its own, as the plugin 170-java-documentation/plugin install 170-java-documentation after adding the marketplace above.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for 170-java-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/jabrena/plinth/170-java-documentation/github.svg)](https://agentmods.dev/skills/jabrena/plinth/170-java-documentation)
Your own site
<a href="https://agentmods.dev/skills/jabrena/plinth/170-java-documentation"><img src="https://agentmods.dev/badge/skills/jabrena/plinth/170-java-documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for 170-java-documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/jabrena/plinth/170-java-documentation"><img src="https://agentmods.dev/badge/skills/jabrena/plinth/170-java-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 95 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 640 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe. Third-party audits
  • NVIDIA SkillSpector pass 7 Sept 2026
How audits are shown
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.1 $0.00095 $0.00640
Opus 5 $0.00048 $0.00320
Sonnet 5 $0.00019 $0.00128
Haiku 4.5 $0.00010 $0.00064

Measured 7d ago against content hash d01cac34b720, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-10, 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 7d ago.

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.

skills/170-java-documentation/SKILL.md · 60 lines

How it starts

The opening of the file, as written. The whole thing — 60 lines — stays where its author put it; the contents beside it link to each section on GitHub.

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
  • EDGE CASE: If request scope is ambiguous, stop and ask a clarifying question before applying changes
  • EDGE CASE: If required inputs, files, or tooling are missing, report what is missing and ask whether to proceed with setup guidance

When to use this skill

  • Improve the code with documentation
  • Apply documentation
  • Refactor the code with documentation
  • Generate README or developer documentation for a Java project
  • Document Java APIs architecture or project workflows

Workflow

  1. Validate project before documentation changes

Run ./mvnw validate or mvn validate and stop immediately if validation fails.

  1. Read documentation reference and gather scope

Read references/170-java-documentation.md and identify required outputs (README, package-info, Javadoc enhancements).

Read the full file on GitHub · 60 lines

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. 7d ago First seen · 60 lines · 95 tokens per session scan A d01cac34b720

Subscribe to this mod's changes

170-java-documentation is a skill published in the GitHub repository jabrena/plinth (438 stars, last pushed yesterday), licensed Apache-2.0. It adds 95 tokens to every session and 640 once invoked, about $0.0005 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-09-03.

Related

Other skills, from other repositories

design-patterns

Common design patterns with Java examples (Factory, Builder, Strategy, Observer, Decorator, etc.). Use when user asks "implement pattern", "use factory", "strategy pattern", or when designing extensible components.

decebals/claude-code-java · 47 tokens

jpa-patterns

JPA/Hibernate patterns and common pitfalls (N+1, lazy loading, transactions, queries). Use when user has JPA performance issues, LazyInitializationException, or asks about entity relationships and fetching strategies.

decebals/claude-code-java · 47 tokens

concurrency-review

Review Java concurrency code for thread safety, race conditions, deadlocks, and modern patterns (Virtual Threads, CompletableFuture, @Async). Use when user asks "check thread safety", "concurrency review", "async code review", or when reviewing multi-threaded code.

decebals/claude-code-java · 58 tokens

test-quality

Write high-quality JUnit 5 tests with AssertJ assertions. Use when user says "add tests", "write tests", "improve test coverage", or when reviewing/creating test classes for Java code.

decebals/claude-code-java · 45 tokens

java-code-review

Systematic code review for Java with null safety, exception handling, concurrency, and performance checks. Use when user says "review code", "check this PR", "code review", or before merging changes.

decebals/claude-code-java · 45 tokens

performance-smell-detection

Detect potential code-level performance smells in Java - streams, collections, boxing, regex, object creation. Provides awareness, not absolutes - always measure before optimizing. For JPA/database performance, use jpa-patterns instead.

decebals/claude-code-java · 51 tokens