javadoc-authoring

javadoc-authoring is a skill for Claude Code, Codex from Netcracker/qubership-ai-packages. It costs 191 tokens per session (13,108 once invoked), scanned A, original, Apache-2.0.

A writing guide for Javadoc and related JVM-language comments, such as KDoc, Groovydoc, and Scaladoc, which explain code to developers and documentation tools.

In plain words
What is it for?
Use it to write, edit, review, compare, or decide whether to add documentation comments to JVM code.
Why use it?
It prevents documentation conventions from being mixed up across Java and other JVM languages.

Skill for Claude CodeCodex

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

Good fit Use it to write, edit, review, compare, or decide whether to add documentation comments to JVM code.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/netcracker/qubership-ai-packages/javadoc-authoring
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 Netcracker/qubership-ai-packages --skill javadoc-authoring
Clone the repo
git clone --depth 1 https://github.com/Netcracker/qubership-ai-packages

Made for: Claude Code, Codex.

Its marketplace also offers this one on its own, as the plugin javadoc-authoring/plugin install javadoc-authoring 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 javadoc-authoring

README.md
[![agentmods](https://agentmods.dev/badge/skills/netcracker/qubership-ai-packages/javadoc-authoring/github.svg)](https://agentmods.dev/skills/netcracker/qubership-ai-packages/javadoc-authoring)
Your own site
<a href="https://agentmods.dev/skills/netcracker/qubership-ai-packages/javadoc-authoring"><img src="https://agentmods.dev/badge/skills/netcracker/qubership-ai-packages/javadoc-authoring/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 javadoc-authoring

Your own site · 80×15
<a href="https://agentmods.dev/skills/netcracker/qubership-ai-packages/javadoc-authoring"><img src="https://agentmods.dev/badge/skills/netcracker/qubership-ai-packages/javadoc-authoring.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 191 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 13,108 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.
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.00191 $0.13108
Opus 5 $0.00096 $0.06554
Sonnet 5 $0.00038 $0.02622
Haiku 4.5 $0.00019 $0.01311

Measured 2d ago against content hash f32712c99235, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-12, from the pricing page.

Security

Grade A, and why

javadoc-authoring 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 2d 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.

agent-packages/javadoc-authoring/.apm/skills/javadoc-authoring/SKILL.md · 872 lines

How it starts

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

Authoring a Javadoc comment

This skill governs what a doc comment says and in what order. Wording, tone, sentence length, and dialect belong to english-developer-style: load it too, and defer to it on the prose. The two compose: this skill picks the slots; that one writes the sentences.

Everything below is written for Javadoc and holds for the JVM's other doc-comment dialects, which share its tag vocabulary and its summary-table rendering. KDoc differs in one place worth knowing before you reach §5: it links with [Foo] and [Foo.bar] rather than {@link}, and it has no {@code}; backticks do that job.

Do not carry these rules into a language outside that family. Python's own PEP 257 prescribes the imperative Return that where this file prescribes Returns that (§3), and which mood wins there is a project decision rather than a given. Rust, TypeScript, and JavaScript each have reference and tag machinery that §5 and §6 do not describe, and Rust's doc comments compile and run as tests. Those languages need their own rules, not a translation of these.

1. The correction that matters most

"Document the why, not the what" is half wrong for a doc comment, and the wrong half does the damage.

An inline // comment documents the why; it sits next to code the reader can already see. A doc comment documents the contract: what a caller may rely on, what an implementer must guarantee, what holds before and after. That is a what at the level of a promise, not a restatement of the code.

The failure mode is therefore not "explains what the code does". It is either of these:

  • Narrating the implementation. Loops over the entries and adds each to the map. The body already states it, and the comment becomes false on the next refactor.
  • Justifying the code's existence. This class was added because the old approach did not scale. That belongs in the commit message and the PR description. A doc comment's reader has to use or fix the thing, not decide whether to merge it.

Read the full file on GitHub · 872 lines

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. 2d ago Changed · -11 lines f32712c99235
  2. 7d ago Changed · +253 lines · -32 tokens per session 148375203d80
  3. 12d ago First seen · 630 lines · 223 tokens per session scan A 90fab3c336f2

Subscribe to this mod's changes

javadoc-authoring is a skill published in the GitHub repository Netcracker/qubership-ai-packages (4 stars, last pushed 3d ago), licensed Apache-2.0. It adds 191 tokens to every session and 13,108 once invoked, about $0.0010 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

azure-security-keyvault-secrets-java

Azure Key Vault Secrets Java SDK for secret management. Use when storing, retrieving, or managing passwords, API keys, connection strings, or other sensitive configuration data.

microsoft/skills · 40 tokens

azure-ai-anomalydetector-java

Build anomaly detection applications with Azure AI Anomaly Detector SDK for Java. Use when implementing univariate/multivariate anomaly detection, time-series analysis, or AI-powered monitoring.

microsoft/skills · 43 tokens

azure-communication-chat-java

Build real-time chat applications with Azure Communication Services Chat Java SDK. Use when implementing chat threads, messaging, participants, read receipts, typing notifications, or real-time chat features.

microsoft/skills · 41 tokens

azure-communication-common-java

Azure Communication Services common utilities for Java. Use when working with CommunicationTokenCredential, user identifiers, token refresh, or shared authentication across ACS services.

microsoft/skills · 35 tokens

azure-ai-agents-persistent-java

Azure AI Agents Persistent SDK for Java. Low-level SDK for creating and managing AI agents with threads, messages, runs, and tools. Triggers: "PersistentAgentsClient", "persistent agents java", "agent threads java", "agent runs java", "streaming agents java".

microsoft/skills · 63 tokens

union-type-wrappers

Add typed getters and setters over BinaryData properties that represent TypeSpec union types in generated Java models. Use when generated classes expose BinaryData for union-typed fields and you need ergonomic, type-safe accessors instead.

Azure/azure-sdk-for-java · 49 tokens