Resolve initProperties KDoc link and remove redundant self-imports - #121
Merged
Conversation
- ContentDsl.kt: fix the unresolved `[initProperties]` KDoc link. initProperties is a companion member of Property, which isn't in scope here, so the bare link rendered as plain text (Dokka: "Couldn't resolve link"). Use the custom-link- text form pointing at the fully-qualified target so no import is needed: [Property.initProperties][com.readingbat.common.Property.initProperties]. Dokka now generates with zero warnings. - Property.kt, ConfigureOAuth.kt, GeoInfo.kt, ReadingBatServer.kt, AdminRoutes.kt: drop redundant imports of symbols defined in each file's own object/companion. - Intercepts.kt: collapse `if (suffix.isEmpty()) return true; return ...` into `return suffix.isEmpty() || ...` (behavior-preserving). Verified: ./gradlew check green (364 tests, 0 failures). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
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
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
Fixes a broken KDoc link and cleans up redundant imports across a handful of files.
ContentDsl.kt— resolve the[initProperties]KDoc linkinitProperties()is a companion-object member ofProperty, which is not in scope inContentDsl.kt(the file only imports individualProperty.Xmembers). So the bare[initProperties]link had nothing to bind to and rendered as plain text — Dokka reportedCouldn't resolve link: [initProperties].Fixed with KDoc's custom-link-text form, which reads cleanly in prose while binding to the fully-qualified target, so no extra import is needed:
Dokka (
dokkaGenerateModuleHtml) now generates with zero warnings.Redundant self-import removals
Property.kt,ConfigureOAuth.kt,GeoInfo.kt,ReadingBatServer.kt,AdminRoutes.kt— each was importing symbols already defined in its own object/companion. Removed.Intercepts.kt— minor simplification (behavior-preserving)Verification
./gradlew check: 364 tests, 0 failures. Dokka module generation clean.🤖 Generated with Claude Code