Agent skill

Add Javadoc

by OpenHands in OpenHands/extensions

Add comprehensive JavaDoc documentation to Java classes and methods.

MITAuto-check passedDevelopment

Install Add Javadoc

skills CLI
$ npx skills add OpenHands/extensions --skill add-javadoc -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install OpenHands/extensions add-javadoc --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/OpenHands/extensions.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/add-javadoc .claude/skills/add-javadoc && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
add-javadoc
GitHub stars
158
Token cost
~292 tokens
SKILL.md length
104 words
Files
6 (incl. references)
Skills in repo
78
Repo updated
First seen
Licence
MIT

At a glance

Add comprehensive JavaDoc documentation to Java classes and methods.

  • Documenting Java code
  • SKILL.md covers Class-Level Documentation, Method-Level Documentation and Style Guidelines
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Adding API documentation

What it does

Add Javadoc is an agent skill from OpenHands/extensions. Add comprehensive JavaDoc documentation to Java classes and methods. Use when documenting Java code, adding API documentation, or improving code documentation.

Its SKILL.md is about 290 tokens, which your agent loads only when the skill is triggered. The skill folder holds 7 other files, including reference files (for example `.plugin/plugin.json`, `README.md` and `references/example.md`). Compatibility notes: Requires Java source files

It sits in Development, covering Technical documentation. It works with Java. The repository describes itself as: Public registry for OpenHands extensions. The licence is MIT.

When your agent uses it

  • Documenting Java code
  • Adding API documentation
  • Improving code documentation

Example prompts

  • “/add-javadoc”

Requirements

  • Compatibility (from SKILL.md): Requires Java source files

What it can do on your machine

Read from SKILL.md and the folder at commit d008b81. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

  • Compatibility

    Requires Java source files

    From compatibility in the SKILL.md frontmatter.

Context cost

Add Javadoc loads about 292 tokens when it runs, and up to ~431 if it reads all its reference files. Until then it costs about 43 tokens; SKILL.md has 104 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~43
When it runs · the whole SKILL.md, loaded when a task matches
~292
With references · SKILL.md plus every file in references/, read only if the agent opens them
~431

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from OpenHands/extensions at commit d008b81, republished under its MIT licence (© OpenHands). 104 words, ~292 tokens.

Download SKILL.mdSave it as .claude/skills/add-javadoc/SKILL.md (or your agent's skills folder). This skill also uses 5 other files; get the full folder from GitHub.
name
add-javadoc
description
Add comprehensive JavaDoc documentation to Java classes and methods. Use when documenting Java code, adding API documentation, or improving code documentation.
compatibility
Requires Java source files
license
MIT
triggers
javadoc, java documentation, document java

Add comprehensive JavaDoc documentation to all public classes and methods.

Class-Level Documentation

For each public class:

  • Add class-level JavaDoc describing the purpose and responsibility of the class
  • Include @author tag if appropriate

Method-Level Documentation

For each public method:

  • Add method-level JavaDoc describing what the method does
  • Include @param tags for all parameters with clear descriptions
  • Include @return tag describing the return value
  • Include @throws tags for any checked exceptions

Style Guidelines

  • First sentence should be a concise summary
  • Use HTML tags sparingly (prefer plain text)
  • Document preconditions and postconditions when relevant
  • Include code examples with {@code ...} for complex methods

See references/example.md for before/after examples.

© OpenHands, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 5 other files (references) in skills/add-javadoc of OpenHands/extensions.

  • SKILL.md
  • .claude-plugin
  • .codex-plugin
  • .plugin/plugin.json
  • README.md
  • references/example.md

Open the folder on GitHubat commit d008b81

Compare with similar skills

Add Javadoc next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Add Javadoc compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Add Javadoc this skillOpenHands/extensions158—~292Automated safety check: PassMIT
Mkdocsjeka-dev/jeka176—~2kAutomated safety check: PassApache-2.0
Releasesol4k/sol4k135—~949Automated safety check: PassApache-2.0
Clarify Java CommentsDataDog/dd-trace-java736—~2.3kAutomated safety check: NotesApache-2.0
Releaseosama-raddad/FireCrasher147—~649Automated safety check: PassApache-2.0
Lc Javayennanliu/CS_basics142—~5.2kAutomated safety check: NotesNone

Similar skills

  • Mkdocs

    jeka-dev/jeka

    MkDocs documentation project reference covering CLI commands, mkdocs.yml configuration, Material theme setup, and plugin integration.

    176 GitHub stars~2k tokensUpdated 2 mo ago
    DevelopmentAuto-check passed
  • Release

    sol4k/sol4k

    Bump the sol4k library version everywhere, open a release PR, and draft GitHub release notes.

    135 GitHub stars~949 tokensUpdated 10 days ago
    DevelopmentAuto-check passed
  • Clarify Java Comments

    DataDog/dd-trace-java

    Official

    Clarify or review Java Javadocs, Javadoc tags, and explanatory code comments for legibility, accuracy, and source alignment.

    736 GitHub stars~2.3k tokensUpdated today
    DevelopmentAuto-check: notes
  • Release

    osama-raddad/FireCrasher

    Cut a new FireCrasher library release — bump the version, sync the README and ABI baseline, verify, and tag for JitPack.

    147 GitHub stars~649 tokensUpdated 3 mo ago
    DevelopmentAuto-check passed
  • Lc Java

    yennanliu/CS_basics

    File a LeetCode Java solution into this repo the way the existing ones are filed — put it in the package its pattern owns, write the file-level javadoc header (<number.

    142 GitHub stars~5.2k tokensUpdated today
    DevelopmentAuto-check: notes
  • Lc Python

    yennanliu/CS_basics

    File a LeetCode Python solution into this repo the way the existing ones are filed — find the problem's real slug, write the Python file in the house layout (problem docstring, V0 with an IDEA block…

    142 GitHub stars~4.4k tokensUpdated today
    DevelopmentAuto-check: notes

More from OpenHands/extensions

All 78 skills in this repo
  • GitHub

    OpenHands/extensions

    Interact with GitHub repositories, pull requests, issues, and workflows using the GITHUBTOKEN environment variable and GitHub CLI.

    158 GitHub starsUsed in 1 repo~1.7k tokens
    Auto-check passed
  • Agent Readiness Report

    OpenHands/extensions

    Evaluate how well a codebase supports autonomous AI-assisted development.

    158 GitHub stars~1.1k tokensUpdated yesterday
    Auto-check passed
  • Discord

    OpenHands/extensions

    Build and automate Discord integrations (bots, webhooks, slash commands, and REST API workflows).

    158 GitHub stars~1.1k tokensUpdated yesterday
    Auto-check passed
  • GitHub Issue To PR

    OpenHands/extensions

    Create an automation that implements GitHub issues when a configurable trigger label is applied.

    158 GitHub stars~4.4k tokensUpdated yesterday
    Auto-check passed
  • GitHub Repo Monitor

    OpenHands/extensions

    This skill should be used when the user asks to "monitor a GitHub repository", "watch GitHub for issues or PRs", "respond to @OpenHands mentions on GitHub", "set up an OpenHands GitHub integration"…

    158 GitHub stars~3.1k tokensUpdated yesterday
    Auto-check passed
  • GitLab Issue To Mr

    OpenHands/extensions

    Create an automation that implements GitLab issues when a configurable trigger label is applied.

    158 GitHub stars~4.9k tokensUpdated yesterday
    Auto-check passed

Works with

Categories

Questions about Add Javadoc

What does Add Javadoc do?

Add comprehensive JavaDoc documentation to Java classes and methods. Add Javadoc is an agent skill from OpenHands/extensions. Add comprehensive JavaDoc documentation to Java classes and methods.

When should I use Add Javadoc?

Add Javadoc fits situations like: documenting Java code; adding API documentation; improving code documentation.

How do I install Add Javadoc in Claude Code?

Run `npx skills add OpenHands/extensions --skill add-javadoc -a claude-code`. Or copy the skill folder (skills/add-javadoc in OpenHands/extensions) into .claude/skills/add-javadoc in your project. Claude Code loads it when a task matches its description.

How do I install Add Javadoc in Codex?

Run `npx skills add OpenHands/extensions --skill add-javadoc -a codex`. Or copy the skill folder (skills/add-javadoc in OpenHands/extensions) into .agents/skills/add-javadoc in your project. Codex loads it when a task matches its description.

Can I use Add Javadoc in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add OpenHands/extensions --skill add-javadoc -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/add-javadoc, .gemini/skills/add-javadoc, .github/skills/add-javadoc and .opencode/skills/add-javadoc in your project.

What does Add Javadoc need to run?

SKILL.md names no scripts, command-line tools or credentials: Add Javadoc is instructions for the agent only. Compatibility (from SKILL.md): Requires Java source files.

Does Add Javadoc access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Add Javadoc safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Add Javadoc use?

Add Javadoc is published under the MIT licence (declared in SKILL.md). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Add Javadoc use?

About 292 tokens (SKILL.md is roughly 1.2k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 139 tokens, read only when the agent opens those files.

What are the alternatives to Add Javadoc?

Skills that share tags, products or a category with Add Javadoc: Mkdocs (jeka-dev/jeka, 176 stars), Release (sol4k/sol4k, 135 stars), Clarify Java Comments (DataDog/dd-trace-java, 736 stars) and Release (osama-raddad/FireCrasher, 147 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Add Javadoc?

OpenHands (a GitHub organization) maintains it in OpenHands/extensions, which has 158 GitHub stars. The repository holds 78 skills in this directory. The repository was last updated on October 7, 2026.

Source: OpenHands/extensions on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.