Skip to content

refactor: hide internal packages and main() from Dokka docs#100

Merged
sriniketh merged 3 commits into
mainfrom
refactor/hide-internal-from-dokka
Apr 17, 2026
Merged

refactor: hide internal packages and main() from Dokka docs#100
sriniketh merged 3 commits into
mainfrom
refactor/hide-internal-from-dokka

Conversation

@sriniketh
Copy link
Copy Markdown
Owner

Summary

  • Made parseFile() in dev.sriniketh.helpers package internal to exclude from Dokka docs
  • Made LibrariesAndLicenses, Library, License model classes internal to exclude from Dokka docs
  • Added suppressedFiles config for Main.kt since the entry point main() function cannot be made internal

Dokka V2 only documents PUBLIC/PROTECTED by default, so internal visibility automatically hides these from generated documentation.

Test plan

  • ./gradlew allTests — all tests pass (internal is visible to same-module test sources)
  • ./gradlew compileKotlinMacosArm64 — compiles successfully
  • ./gradlew dokkaGenerate — verified dev.sriniketh.helpers/, dev.sriniketh.models/, and main.html are no longer in output
  • Public API docs (UUID, hash, encoding functions, etc.) still present

🤖 Generated with Claude Code

@sriniketh sriniketh merged commit 2cfeb5e into main Apr 17, 2026
5 checks passed
@sriniketh sriniketh deleted the refactor/hide-internal-from-dokka branch April 17, 2026 16:24
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.

1 participant