Skip to content

Exported public APIs lack complete Javadoc #34

@nficano

Description

@nficano

The exported public surface does not consistently carry Javadoc, and the build disables doclint with Xdoclint:none in build.gradle.kts. Examples include public records and types such as Session at arcp-client/src/main/java/dev/arcp/client/Session.java line 11, Page at arcp-client/src/main/java/dev/arcp/client/Page.java line 7, SubscribeOptions at arcp-client/src/main/java/dev/arcp/client/SubscribeOptions.java line 3, CredentialId at arcp-core/src/main/java/dev/arcp/core/credentials/CredentialId.java line 7, Feature at arcp-core/src/main/java/dev/arcp/core/capabilities/Feature.java line 8, and many public builder methods in ArcpClient and ArcpRuntime. The existing comments often document the class but not public methods, parameters, return values, or checked and documented unchecked exceptions.

Fix prompt: Audit every public and protected type, constructor, method, record component, and enum that is part of the published SDK modules and add idiomatic Javadoc. Each public type and method should have a meaningful first-sentence summary, use @param for non-obvious parameters and type parameters, @return where the return value is not self-evident, and @throws for checked exceptions and intentionally documented unchecked exceptions. Use {@code} for literals and wire names, {@link} for related SDK APIs, and then remove Xdoclint:none or at least enable doclint in CI so missing or malformed API documentation is caught before release.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationseverity:mediumMedium severity

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions