Add Javadoc

Add comprehensive JavaDoc documentation to all public classes and methods.

Class-Level Documentation

For each public class:

• Add class-level JavaDoc describing the purpose and responsibility of the class
• Include @author tag if appropriate

Method-Level Documentation

For each public method:

• Add method-level JavaDoc describing what the method does
• Include @param tags for all parameters with clear descriptions
• Include @return tag describing the return value
• Include @throws tags for any checked exceptions

Style Guidelines

• First sentence should be a concise summary
• Use HTML tags sparingly (prefer plain text)
• Document preconditions and postconditions when relevant
• Include code examples with {@code ...} for complex methods

See references/example.md for before/after examples.

add-javadoc

Add comprehensive JavaDoc documentation to Java classes and methods. Use when documenting Java code, adding API documentation, or improving code documentation.

Triggers

This skill is activated by the following keywords:

• javadoc
• java documentation
• document java

Details

This skill guides the agent to add standard JavaDoc comments to all public classes and methods in Java source files.

Class-Level Documentation

For each public class, the agent will:

• Add a class-level JavaDoc block describing the purpose and responsibility of the class
• Include an @author tag if appropriate

Method-Level Documentation

For each public method, the agent will:

• Add a method-level JavaDoc block describing what the method does
• Include @param tags for all parameters with clear descriptions
• Include a @return tag describing the return value
• Include @throws tags for any checked exceptions

Style Guidelines

• First sentence should be a concise summary
• Use HTML tags sparingly (prefer plain text)
• Document preconditions and postconditions when relevant
• Include code examples with {@code ...} for complex methods

Example

See references/example.md for a before/after example showing undocumented Java code transformed with proper JavaDoc comments.

JavaDoc Example

Before

public class UserService {
    public User findById(String id) {
        return repository.find(id);
    }
}

After

/**
 * Service for managing user operations.
 *
 * @author Generated by Large Codebase SDK
 */
public class UserService {
    /**
     * Finds a user by their unique identifier.
     *
     * @param id The unique identifier of the user
     * @return The User object if found, null otherwise
     */
    public User findById(String id) {
        return repository.find(id);
    }
}