dart-doc-validation

Validates Dart documentation comments using dart doc to catch unresolved references and macros.

1|Updated Apr 30, 2026
One-click install
npx skills add https://github.com/Wishtohear/bucket-water-oms --skill dart-doc-validation-wishtohear
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: dart-doc-validation
Source: https://github.com/Wishtohear/bucket-water-oms/tree/main/bucket-water-oms-admin-mobile/tool/dart_skills_lint/.agents/skills/dart-doc-validation
Command: npx skills add https://github.com/Wishtohear/bucket-water-oms --skill dart-doc-validation-wishtohear

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Broken documentation links, unresolved references, and undefined macros in Dart doc comments silently degrade package documentation quality and can block publishing to pub.dev. This Skill provides a repeatable workflow to detect and fix these issues before release. ## Core Features & Use Cases - Local Documentation Validation: Runs dart doc with a temporary output directory to surface warnings like unresolved doc references and undefined macros without cluttering the project workspace. - Warning Diagnosis Guidance: Explains how to fix unresolved [Identifier] references by pointing them to existing classes, methods, or parameters in scope. - Macro Troubleshooting: Shows how to resolve {@macro} errors by ensuring matching {@template} definitions exist in visible files. - Use Case: Before publishing a Dart package to pub.dev, run the validation command to catch all broken doc references, then fix each warning so the generated API documentation renders correctly. ## Quick Start Validate the Dart documentation comments in this package and report any unresolved references or undefined macros.

Frequently Asked Questions about dart-doc-validation

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

FAQPage Schema
How do I validate Dart documentation comments locally?▼

Run dart doc with a temporary output directory, such as dart doc -o $(mktemp -d). This parses all documentation comments and reports warnings like unresolved doc references and undefined macros without generating files in your project directory.

How to fix unresolved doc reference warnings in Dart?▼

Unresolved doc reference warnings occur when an identifier in square brackets does not point to an existing symbol. Ensure the bracketed identifier matches an existing class, method, property, or parameter in the current scope or an imported library.

Why does dart doc report undefined macro warnings?▼

Undefined macro warnings happen when a {@macro macro_name} reference has no matching {@template macro_name} definition. The template must be defined in the same file or in an imported file visible to the documentation generator.

Should I check Dart doc warnings before publishing to pub.dev?▼

Yes, validating documentation before publishing ensures generated API docs render correctly on pub.dev. Running dart doc locally surfaces all warnings so you can fix broken references and macros before release.