Skip to content
pubscout

dartdoc

9.0.11, released 6 weeks ago by tools.dart.dev

A non-interactive HTML documentation generator for Dart source code.

Rock solid
$ flutter pub add dartdoc
Source repository

What it does

Generates static HTML API documentation from Dart source code and documentation comments. It analyzes packages, processes tags like categories and macros, and produces navigable HTML output.

AI-written summary of version 9.0.11, based on the package's README and metadata. Report an inaccuracy

Use it when

  • You need to generate offline-viewable API documentation for a Dart package
  • You want to produce standard HTML documentation for your Dart codebase

Skip it when

  • You need an interactive documentation viewer built into your application
  • You are looking for code generation for JSON parsing or data models

Strengths

  • Official Dart documentation generation tool
  • Supports advanced features like categories, macros, and external tools
  • Predictable static HTML output structure

Weaknesses

  • Requires an HTTP server to fully view navigation and search locally
  • Requires package to analyze without errors before generating docs

Setup

Kind
Pure Dart
Effort
Low
Code generation
No
Direct dependencies
14

Part of the Dart SDK; run via 'dart doc .'

dart doc .

Alternatives

Packages that do the same job and could replace dartdoc.

Works with

Packages commonly used together with dartdoc: ones it builds on, ones built on it, and its own family.