170-java-documentation

name	170-java-documentation
description	Use when you need to generate or improve Java project documentation — including README.md files, package-info.java files, and Javadoc enhancements — through a modular, step-based interactive process that adapts to your specific documentation needs. This should trigger for requests such as Improve the code with documentation; Apply documentation; Refactor the code with documentation; Generate README or developer documentation for a Java project; Document Java APIs architecture or project workflows. Part of Plinth Toolkit
license	Apache-2.0
metadata	{"author":"Juan Antonio Breña Moral","version":"0.18.0"}

Java Documentation Generator with modular step-based configuration

Generate comprehensive Java project documentation through a modular, step-based interactive process that covers README.md, package-info.java, and Javadoc. This is an interactive SKILL.

What is covered in this Skill?

• README.md generation for single-module and multi-module Maven projects
• package-info.java creation with basic/detailed/minimal documentation levels
• Javadoc enhancement: comprehensive @param/@return/@throws tags
• File handling strategies: overwrite/add/backup/skip
• Final documentation validation with ./mvnw clean compile and ./mvnw javadoc:javadoc

Constraints

Before applying any documentation generation, ensure the project validates. If validation fails, stop immediately — do not proceed until all validation errors are resolved.