Skip to content

Conversation

@leumor
Copy link
Collaborator

@leumor leumor commented Nov 8, 2025

Summary

  • Expand and clarify Javadoc in the client layer to satisfy doclint and improve developer-facing documentation.

Changes

  • src/main/java/network/crypta/client/MetadataParseException.java: Replace terse comment with a detailed class-level Javadoc describing intent, usage, immutability, and relationship to parse errors; add constructor Javadoc with guidance and example snippet.
  • src/main/java/network/crypta/client/MetadataUnresolvedException.java: Add comprehensive class-level Javadoc distinguishing resolution failures from parse errors, thread-safety notes, and @see links; document the semantics of the mustResolve array and the constructor parameters with an example.
  • src/main/java/network/crypta/client/package-info.java: Rewrite package overview to describe responsibilities (metadata parsing/validation, retrieval planning, container handling) and the error model; include references to standard types for context.

Rationale

  • Aligns with recent efforts to clean up Javadoc with doclint enabled across the client module.
  • Improves clarity around error semantics between malformed metadata (parse) and unresolved dependencies (resolve-and-retry paths).

Scope and Risk

  • Documentation-only changes; no functional code paths modified.
  • Builds should be unaffected beyond doc generation. Spotless has been applied.

Commits

  • a2544f7 docs(client): clarify Javadoc for metadata exceptions and package overview

Checks

  • Ran ./gradlew spotlessApply locally to ensure formatting.

Please let me know if you'd like additional cross-links or examples added.

…rview

- Expand Javadoc for MetadataParseException and MetadataUnresolvedException with intent, usage, and thread-safety notes
- Rewrite package-info for client package to describe responsibilities and common patterns

This aligns with Javadoc doclint requirements and improves developer-facing documentation.
@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 8, 2025

@leumor leumor merged commit 24216cd into develop Nov 8, 2025
4 checks passed
@leumor leumor deleted the feature/javadoc-client-doclint branch November 8, 2025 20:14
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