Skip to content
TrustedSkillsbeta
Back to all skills

170 Java Documentation

Checked
jabrena·vlatest·backend·Apache-2.0

Helps with Java, documentation as part of developing backend services and APIs workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add jabrena/plinth --skill 170-java-documentation -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

jabrena

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

  • Declares what it does: passed

    SKILL.md parses and declares a name and a description.

    SKILL.md exists, its frontmatter parses, and it declares a name and a description.

  • No undeclared network calls: passed

    Makes no network calls.

    Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.

  • No obfuscated payloads: passed

    No encoded or obfuscated payloads.

    No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.

  • No credential access: passed

    Reads no keys, tokens, keychains or credential files.

    Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.

  • No pipe-to-shell installers: passed

    No pipe-to-shell or download-and-run installers.

    No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.

  • Pinned to a commit: passed

    Scanned jabrena/cursor-rules-java at 8ac07fb219.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
8ac07fb219
Manifest
skills/170-java-documentation/SKILL.md
Scanned
1 file, 60 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

About this skill

What it does

This skill allows AI agents to understand and generate Java documentation. It can parse existing JavaDoc comments, extract information about classes, methods, and parameters, and then produce formatted documentation in various output formats. The agent can also create new JavaDoc comments based on provided code or descriptions.

When to use it

  • Generating API Documentation: Automatically create comprehensive API documentation for a Java project from source code.
  • Understanding Existing Code: Quickly understand the purpose and usage of existing Java classes and methods by extracting their Javadoc.
  • Creating New JavaDoc Comments: Generate initial or updated Javadoc comments when writing new Java code.
  • Refactoring Documentation: Update documentation to match changes in the underlying codebase, ensuring accuracy and consistency.

Key capabilities

  • Parses existing JavaDoc comments
  • Extracts information about classes, methods, and parameters
  • Generates formatted documentation
  • Creates new Javadoc comments based on code or descriptions

Example prompts

  • "Generate Javadoc for the com.example.MyClass class."
  • "Create a Javadoc comment describing the purpose of this method: public int calculateSum(int a, int b)."
  • “Extract all @param tags from this Java file.”

Tips & gotchas

  • The skill requires access to valid Java source code files.
  • Complex or poorly formatted JavaDoc may be difficult for the agent to parse accurately.