Skip to content

Add KDoc to public API across all modules (KOJAK-36)#10

Merged
endrju19 merged 6 commits intomainfrom
next-feat
Mar 30, 2026
Merged

Add KDoc to public API across all modules (KOJAK-36)#10
endrju19 merged 6 commits intomainfrom
next-feat

Conversation

@endrju19
Copy link
Copy Markdown
Collaborator

Summary

  • Add KDoc documentation to all 15 undocumented public Kotlin files across 5 modules (core, http, kafka, postgres, mysql)
  • Follow existing project KDoc style: concise, [ClassName] references, no @param/@return
  • Documentation-only changes — zero code modifications, 80 lines added

Modules covered

Module Files What was documented
okapi-core 6 Data classes, enums, sealed interface (OutboxMessage, OutboxId, OutboxStatus, OutboxEntry, DeliveryResult, RetryPolicy)
okapi-http 4 Transport impl, delivery info, DSL builder with usage example, enum
okapi-kafka 3 Transport impl, delivery info, DSL builder with usage example
okapi-postgres 1 Store implementation class
okapi-mysql 1 Store implementation class

Test plan

  • ./gradlew ktlintCheck — passed
  • ./gradlew compileKotlin — passed (verifies KDoc [references] don't break compilation)
  • No code changes — only KDoc comment additions

@endrju19 endrju19 merged commit 049f132 into main Mar 30, 2026
7 checks passed
@endrju19 endrju19 deleted the next-feat branch March 30, 2026 06:56
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