kdoc-fundamentals

Name: kdoc-fundamentals
Availability: InStock
Author: krystianycsilva

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

Updated Feb 20, 2026

Search Tags:#documentation #api docs #kotlin #kdoc #kotlin multiplatform #dokka

Ready to run

npx skills add https://github.com/KrystianYCSilva/data-structures-and-algorithms --skill kdoc-fundamentals

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: kdoc-fundamentals
Source: https://github.com/KrystianYCSilva/data-structures-and-algorithms/tree/main/.gemini/skills/kdoc-fundamentals
Command: npx skills add https://github.com/KrystianYCSilva/data-structures-and-algorithms --skill kdoc-fundamentals

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill simplifies the process of documenting Kotlin code and generating professional API documentation, ensuring your projects are well-explained and maintainable.

Core Features & Use Cases

KDoc Syntax Guidance: Learn the standard way to write documentation comments in Kotlin.
Dokka Integration: Get examples for setting up Dokka to generate HTML or Markdown documentation from your KDoc comments.
Use Case: Ensure your Kotlin Multiplatform library has clear, accessible documentation for other developers by integrating KDoc and Dokka into your build process.

Quick Start

Use the kdoc-fundamentals skill to learn how to add KDoc comments to your Kotlin functions.

Frequently Asked Questions about kdoc-fundamentals

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

FAQPage Schema

How do I write KDoc comments for Kotlin functions and parameters?▼

KDoc comments in Kotlin use a block format starting with /** and ending with */ to document functions. You document parameters using @param tags and return values using @return tags to generate clear API documentation.

What is the best way to generate API documentation for a Kotlin Multiplatform project?▼

Generating API documentation for a Kotlin Multiplatform project is best done using Dokka. You configure the Dokka Gradle plugin in your build process to automatically generate HTML or Markdown documentation from your KDoc comments.

Does Dokka work with Kotlin Multiplatform projects to generate API docs?▼

Yes, Dokka works with Kotlin Multiplatform projects to generate API documentation. You integrate the Dokka Gradle plugin into your build configuration to automatically produce documentation from your KDoc comments across multiple platforms.

Can I output Markdown instead of HTML when generating Kotlin documentation with Dokka?▼

Yes, you can output Markdown instead of HTML when generating Kotlin documentation. You configure the Dokka Gradle plugin during setup to specify whether the automated documentation generation outputs HTML or Markdown formats.

Why do I need Dokka to generate documentation from KDoc comments?▼

Dokka is needed to generate documentation from KDoc comments because it processes the Kotlin source code and translates the standard documentation comments into accessible HTML or Markdown API references for other developers.

How do I configure the Dokka Gradle plugin for automated documentation generation?▼

You configure the Dokka Gradle plugin by adding it to your project's build configuration. This setup enables automated documentation generation, parsing your KDoc comments to produce professional HTML or Markdown API documentation.