skills.rest
oscardlfr
oscardlfrCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

generate-api-docs

Convert Kotlin KDoc into YAML API documentation using Dokka.

1|Updated Mar 9, 2026
Search Tags:#API documentation#Kotlin#KMP#KDoc#Dokka
One-click install
npx skills add https://github.com/oscardlfr/AndroidCommonDoc --skill generate-api-docs-oscardlfr
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: generate-api-docs
Source: https://github.com/oscardlfr/AndroidCommonDoc/tree/main/skills/generate-api-docs
Command: npx skills add https://github.com/oscardlfr/AndroidCommonDoc --skill generate-api-docs-oscardlfr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires dokka, dokka-markdown-plugin, and includes scripts (resource) components.

What problem does it solve?

This skill automatically generates API documentation in a YAML format, readable by the context-provider and search-docs, from the KDoc present in your source code.

Core Features & Use Cases

  • Dokka Integration: Generates API documentation by utilizing the Dokka Gradle plugin.
  • Transformer: Converts raw Markdown to a YAML-frontmatter format for indexing and searchability.
  • Validation: Offers validation for generated API documents ensuring proper structure and content.
  • Module and Project-wide: Capable of processing multiple modules within a project or entire project documentation.

Quick Start

Execute the /generate-api-docs command followed by the relevant module name or project root path to initiate the documentation generation.

Frequently Asked Questions about generate-api-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate API documentation from Kotlin KDoc comments?▼

The skill transforms KDoc comments within Kotlin source code into API documentation in YAML format using the Dokka plugin. It automatically parses and structures your code comments for searchability.

Does this API documentation generator support Kotlin Multiplatform (KMP) projects?▼

Yes, the API documentation generator fully supports Kotlin Multiplatform (KMP) and Android projects. It is capable of processing multiple modules within a project or generating documentation for the entire project scope.

What output format does the Dokka documentation generator produce?▼

The Dokka documentation generator produces a YAML output format with frontmatter, converting raw Markdown generated by Dokka into a structured, searchable YAML schema. This format is specifically readable by context-providers and search-docs tools.

Do I need the Dokka Gradle plugin to generate Kotlin API docs?▼

Yes, you must have the Dokka Gradle plugin and the additional Dokka markdown plugin installed locally to generate Kotlin API docs. The skill operates on your local system and relies entirely on these dependencies for conversion.

Can I manually edit the generated API documentation during the conversion process?▼

No, manual intervention is not allowed during the API documentation generation process. The skill operates autonomously to transform KDoc into YAML, though it includes a validation step to ensure proper document structure and content.

Related Skills

Explore More Software Engineering Skills→
KrystianYCSilvaKrystianYCSilva

kdoc-fundamentals

Write KDoc comments and configure the Dokka Gradle plugin for Kotlin Multiplatform documentation.

Community
Basic
buyuk-devbuyuk-dev
17

fmql-semantic

Index and search markdown notes with semantic retrieval via LiteLLM embeddings.

Community
Advanced
new-silvermoonnew-silvermoon
915

android-gradle-logic

Centralize Android Gradle build logic with Kotlin DSL convention plugins.

Community
Advanced
SpineEventEngineSpineEventEngine
2

java-to-kotlin

Convert Java source code into idiomatic Kotlin with preserved behavior and API semantics.

Official
Intermediate