Skip to content

Add Javadoc to public API classes #24

@rammrain

Description

@rammrain

Summary

Add Javadoc documentation to all public classes, methods, and constants in the SDK.

Context

CodeRabbit flagged 0% docstring coverage on PR #22. The project currently has no Javadoc on any public API surface, including the exception hierarchy (#21) and configuration (#22).

Scope

  • MontonioSdkConfiguration — class, builder, constants, fields
  • All exception classes in ee.bitweb.montonio.sdk.exception
  • Future public classes as they're added

Notes

The javadoc Gradle task already runs during build and produces warnings for undocumented public members. Adding Javadoc will clean up build output and improve the consumer experience.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions