java-javadoc

Generate Javadoc comments for Java classes, interfaces, and enums.

Updated Jul 9, 2026
One-click install
npx skills add https://github.com/albertoirurueta/ai-catalog --skill java-javadoc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: java-javadoc
Source: https://github.com/albertoirurueta/ai-catalog/tree/main/.claude/skills/java-javadoc
Command: npx skills add https://github.com/albertoirurueta/ai-catalog --skill java-javadoc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the generation and validation of Javadoc comments for Java classes, ensuring that all necessary documentation is complete and correctly formatted, saving developers time and reducing the risk of documentation gaps.

Core Features & Use Cases

  • Javadoc Generation: Automatically generate Javadoc comments based on the source code, including methods, classes, interfaces, and enums.
  • Scope Determination: Supports invocation with specific class names or file paths, or by default, covers classes changed in the current branch.
  • Package-Level Documentation: Ensures that each package has a complete package-info.java file, enhancing project maintainability.
  • Build Verification: Validates the generated Javadoc through the project's build process to ensure compliance with coding standards.

Quick Start

Run the java-javadoc skill with the class name you want to document: /java-javadoc MyClass

Frequently Asked Questions about java-javadoc

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate Javadoc comments for Java classes?

You can automatically generate Javadoc comments for Java classes by invoking the skill with a specific class name or file path. It analyzes source code to create documentation for classes, interfaces, enums, and methods, ensuring comprehensive code documentation.

Can I generate Javadoc only for classes changed in my current branch?

Yes, you can generate Javadoc for changed classes by invoking the skill without specifying a target. By default, it automatically determines the scope and covers only the classes modified in your current Git branch.

How do I ensure package-level documentation is complete in my Java project?

To ensure package-level documentation is complete, the skill automatically generates and verifies a complete package-info.java file for each package. This enhances project maintainability and ensures all package documentation gaps are filled.

Does this Javadoc generation process verify the build compliance?

Yes, the Javadoc generation process validates the output through the project's build automation. It verifies the generated Javadoc to ensure full compliance with your project's coding standards and build configuration.

What is the best way to maintain comprehensive code documentation for Java enums and interfaces?

The best way to maintain comprehensive code documentation is to automate generation based on source code analysis. This skill creates compliant Javadoc comments for Java classes, interfaces, and enums, reducing manual effort and preventing documentation gaps.