Document Kotlin APIs with consistent KDoc syntax and cross-references.
npx skills add https://github.com/HuxleyMc/Android-Skills --skill kdoc-documentation
Please help me install this Agent Skill. Skill: kdoc-documentation Source: https://github.com/HuxleyMc/Android-Skills/tree/main/kdoc-documentation Command: npx skills add https://github.com/HuxleyMc/Android-Skills --skill kdoc-documentation
Kotlin projects often suffer from inconsistent documentation across public and internal APIs. This skill provides clear guidelines for documenting code using KDoc syntax, best practices, and cross-references to produce reliable API references.
Use this skill to structure Kotlin documentation for a module by creating SKILL.md with the described frontmatter and content, then follow the examples to write KDoc in your source files.
High-intent search queries and answers about installing and using this skill.
KDoc comments for a Kotlin API use specific syntax inside block comments to provide short summaries, detailed explanations, parameter descriptions, return values, and exceptions, fully supporting Markdown formatting for reliable API references.
The best way to document Kotlin APIs consistently is to follow standardized KDoc guidelines covering syntax, tags, cross-references, and usage samples to produce reliable library documentation across projects.
Generating HTML documentation from KDoc using Dokka involves applying Dokka-ready patterns to structure your comments, which supports creating multi-module documentation and reliable API references for Kotlin projects.
Yes, you can use Markdown formatting inside KDoc code comments. The syntax explicitly supports Markdown usage for detailed explanations, cross-referencing related classes, and providing usage samples within Kotlin source files.
To cross-reference related classes in Kotlin documentation, apply specific KDoc tag patterns to ensure consistent style and reliable API references across project modules.
KrystianYCSilvaWrite KDoc comments and configure the Dokka Gradle plugin for Kotlin Multiplatform documentation.
oscardlfrConvert Kotlin KDoc into YAML API documentation using Dokka.
oscardlfrOrchestrate KDoc documentation migration across Kotlin APIs with dry-run options.
SpineEventEngineConvert Java source code into idiomatic Kotlin with preserved behavior and API semantics.
