kdoc-audit

Audit KDoc coverage on Kotlin public APIs and report missing documentation.

1|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/oscardlfr/AndroidCommonDoc --skill kdoc-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: kdoc-audit
Source: https://github.com/oscardlfr/AndroidCommonDoc/tree/main/skills/kdoc-audit
Command: npx skills add https://github.com/oscardlfr/AndroidCommonDoc --skill kdoc-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of auditing KDoc coverage on public Kotlin APIs, helping developers ensure their APIs are well-documented.

Core Features & Use Cases

  • KDoc Coverage Audit: Reports undocumented symbols, per-module coverage, and regression warnings.
  • Customizable Reports: Offers various command-line options to customize the report output.
  • Integration: Integrates with other tools and can be used in quality gate workflows.

Quick Start

To perform a full KDoc coverage audit on all modules, run: /kdoc-audit

Frequently Asked Questions about kdoc-audit

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

FAQPage Schema
How do I automate KDoc coverage analysis for Kotlin APIs?

You can automate KDoc coverage analysis for Kotlin APIs by running the audit command to report undocumented symbols, check per-module coverage, and compare results against a baseline. This supports both automated pipelines and manual review.

What is the best way to find missing KDoc documentation in a Kotlin project?

The best way to find missing KDoc documentation is to run a full coverage audit across all modules. The audit reports undocumented public symbols and provides per-module coverage details to highlight exactly where documentation is missing.

Can I check per-module KDoc coverage and compare it against a baseline?

Yes, you can check per-module KDoc coverage and compare it against a baseline. The audit reports undocumented symbols and triggers regression warnings if coverage drops, which is ideal for quality gate workflows.

Does KDoc coverage auditing work in quality assurance pipelines?

KDoc coverage auditing works in quality assurance pipelines by integrating with other tools to automate analysis. It reports missing documentation and regression warnings, fitting naturally into automated quality gate workflows.

How do I customize undocumented symbol reports for my Kotlin API?

You can customize undocumented symbol reports for your Kotlin API using various command-line options. These options allow you to tailor the report output to suit specific manual review or automated quality assurance requirements.