Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Java documentation: README, package-info, Javadoc v1.0.0

Use this resource to generate or improve the documentation of a Java project

New

  • 401 downloads
  • 202 likes
  • 115 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install java-project-documentation

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent works through interactive steps: a README for single or multi-module projects, package-info.java files at three detail levels, then Javadoc tags such as @param, @return and @throws. You choose how existing files are handled: overwrite, add, back up or skip.

Mostly picked by

Updated November 2, 2026

Card for the “Java documentation: README, package-info, Javadoc” skill

Details

Generates with
Your agent's model
Licence
Apache-2.0

Similar resources

View all

What you get

  • SKILL.md : interactive steps and constraints
  • references/170-java-documentation.md : Javadoc templates and rules

Good fit for

  • Your Java project has neither a README nor package-info files
  • You want to complete the Javadoc of public APIs

Not for

    Tags

    • documentation
    • javadoc
    • readme
    • java

    About

    You say

    “Document this multi-module Maven project: README and package-info.”

    Card for the “Java documentation: README, package-info, Javadoc” skill

    Skill published by jabrena under the Apache-2.0 license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to generate or improve the documentation of a Java project
    3. Review and adjust the result

    Content preview

    Files

    • LICENSE11.1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • references/170-java-documentation.md29.6 KB
    • SKILL.md3.1 KB

    Origin and licence

    Listed unmodified

    Author
    jabrena
    Source
    github.com/jabrena/plinth/tree/b1c04e39a93d9aac4a70e5154cd50ab6d47fdcf8/skills/170-java-documentation
    Licence
    Apache-2.0

    Notice

    « 170-java-documentation » (jabrena, Apache-2.0) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.