Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed Checkstyle Issues #417

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Conversation

dariuszzbyrad
Copy link
Collaborator

@dariuszzbyrad dariuszzbyrad commented Nov 20, 2024

This PR addresses various Checkstyle issues by ensuring that all missing Javadoc comments are added and improving the Checkstyle configuration to properly handle documentation-related rules.

Summary of Changes:

  • Javadoc Fixes: Added missing Javadoc comments for methods, fields, and types. Specifically:
    • Added @param, @return, and @throws tags where applicable.
    • Corrected incorrect use of @inheritDoc tags for static methods.
    • Updated Javadoc formatting to align with project standards.

Additional Context:

  • The errors seen in the build were caused by a previous commit (e530765), which inadvertently introduced some violations in Javadoc documentation.

Example Fix for Static Method:

Before:

/** {@inheritDoc} */
public static DigitalOutputBuilder newInstance(Context context) {
    return new DefaultDigitalOutputBuilder(context);
}

After:

/**
 * Creates a new instance of {@link DefaultDigitalOutputBuilder} with the specified context.
 *
 * @param context the context used to initialize the digital output
 * @return a new instance of {@link DigitalOutputBuilder}
 */
public static DigitalOutputBuilder newInstance(Context context) {
    return new DefaultDigitalOutputBuilder(context);
}

This fixes the invalid @inheritDoc tag usage and provides a detailed description of the method's behavior.

@dariuszzbyrad dariuszzbyrad changed the title WIP: Fix javadoc (e.g. add missing tags) WIP: Add checkstyle plugin again and fix javadocs Nov 20, 2024
@dariuszzbyrad dariuszzbyrad changed the title WIP: Add checkstyle plugin again and fix javadocs Fixed Checkstyle Issues Nov 20, 2024
@FDelporte FDelporte merged commit f1ea6ce into Pi4J:develop Nov 20, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants