dart-doc-validation

Validate Dart documentation comments for unresolved references and undefined macros.

Updated Apr 12, 2026

Search Tags:#code quality #documentation #validation #dev tools #dart

Ready to run

npx skills add https://github.com/brahiamsinho/Examen-1-SI2 --skill dart-doc-validation-brahiamsinho

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: dart-doc-validation
Source: https://github.com/brahiamsinho/Examen-1-SI2/tree/main/.cursor/skills/dart-doc-validation
Command: npx skills add https://github.com/brahiamsinho/Examen-1-SI2 --skill dart-doc-validation-brahiamsinho

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill helps to maintain accurate and useful Dart documentation comments, catching common issues like unresolved references and undefined macros before package publication.

Core Features & Use Cases

Validate Documentation: Identify broken links, missing identifiers, and undefined macros.
Pre-Publish Checks: Enhance the quality of your package documentation on pub.dev.
Local Development Aid: Facilitate local documentation validation to maintain a clean codebase.

Quick Start

Run the dart-doc-validation skill to validate the documentation comments within your Dart project.

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 for broken references?▼

To validate Dart documentation, analyze references and macros using dart:doc generation, checking for unresolved identifiers and undefined macros to ensure clean, publish-ready docs.

What issues cause Dart package documentation to fail on pub.dev?▼

Dart documentation often fails due to unresolved references, missing identifiers, and undefined macros, which pre-publish validation detects to ensure accurate package documentation.

Can I check Dart documentation for undefined macros before publishing?▼

Yes, you can check for undefined macros and unresolved references locally before publishing, ensuring your package maintains clean and error-free documentation on pub.dev.

Do I need dart:doc to validate Dart documentation comments?▼

Yes, dart:doc is required to generate documentation and analyze references, enabling the validation of Dart comments for unresolved references and undefined macros.

What is the best way to maintain clean Dart documentation during local development?▼

The best way to maintain clean Dart documentation is running local validation checks to identify broken links and missing identifiers, keeping your codebase documentation error-free.

Why does my Dart documentation validation show unresolved references?▼

Unresolved references appear when documentation comments link to missing identifiers or broken links, requiring validation to catch these errors before package publication.