How does it handle code examples in documentation?

It enforces standards for formatting inline code using {@code} and large blocks with tags to ensure proper rendering.

Can it identify missing documentation?

Yes, the skill is designed to analyze existing source code to find undocumented public APIs, parameters, return values, or exceptions.

Is it suitable for package-level documentation?

Absolutely, it includes specific instructions for creating and maintaining package-info.java files with overview examples.

Does it follow specific JavaDoc tag orders?

Yes, it enforces a standardized tag order: @param, @return, @throws, @see, @since, and @deprecated.

Does this skill support Maven?

Yes, it includes specific workflow steps to verify documentation quality using the Maven javadoc:javadoc plugin.

JavaDoc Documentation Expert

Name: JavaDoc Documentation Expert
Author: cuioss

bycuioss

Learning & Documentation

Generates and maintains high-quality, standardized JavaDoc documentation for Java projects following CUI OSS best practices.

About

The cui-javadoc skill provides a structured workflow for creating and auditing Java documentation to ensure it is professional, consistent, and useful. It enforces specific standards for class and method-level documentation, including proper tag ordering, null-handling specifications, and thread-safety statements. By automating the identification of documentation gaps and validating HTML formatting, this skill helps developers maintain technical documentation that is not only readable but also fully compliant with Maven JavaDoc generation tools.

Key Features

0 GitHub stars
Cross-reference management using @link and @see tags
Standardized formatting for complex code examples and HTML tags
Quality verification via Maven JavaDoc generation checks
Automated enforcement of JavaDoc standards for classes and methods
Comprehensive audit of documentation gaps in public and protected APIs

Use Cases

Creating complex, compilable code examples within API documentation
Documenting new public API components and library features
Auditing and refactoring existing documentation for technical debt reduction

About

Key Features

0 GitHub stars
Cross-reference management using @link and @see tags
Standardized formatting for complex code examples and HTML tags
Quality verification via Maven JavaDoc generation checks
Automated enforcement of JavaDoc standards for classes and methods
Comprehensive audit of documentation gaps in public and protected APIs

Use Cases

Creating complex, compilable code examples within API documentation
Documenting new public API components and library features
Auditing and refactoring existing documentation for technical debt reduction