docs: add missing KDoc across the codebase#61
Merged
Conversation
Add KDoc to public/internal declarations that lacked it (ViewModels, UI-state types, DAOs, DI providers, domain enums, shared composables and a few private helpers whose names were not self-explanatory), following the Kotlin KDoc convention. No trivial comments were found to remove -- the existing inline comments all carry rationale or spec references -- and no code, signatures, or string literals changed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documentation-only pass over the codebase: adds missing KDoc to public and
internal declarations following the Kotlin KDoc convention. No behavior, code,
signatures, or string literals change.
Rationale
A sweep across every package looked for two things: trivial comments that merely
restate the code (to remove) and declarations missing a docstring (to add). The
codebase was already well-commented, so nothing trivial qualified for removal --
every existing inline comment carries rationale, a spec/mockup reference, or a
gotcha. The work was therefore almost entirely additive KDoc on ViewModels,
UI-state types, Room DAOs, DI providers, domain enums/interfaces, and shared
composables (plus a few private helpers whose names were not self-explanatory).
Per-constant and @Preview/@Test/override docs were intentionally skipped to avoid
restating the obvious.
Verification
./gradlew :app:compileDebugKotlin(green)./gradlew :app:ktlintMainSourceSetCheck(green)./gradlew :app:detekt(green)Test plan
Related issues
Checklist
docs/).