dartdoc
9.0.11, released 6 weeks ago by tools.dart.dev
A non-interactive HTML documentation generator for Dart source code.
Rock solid
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.
- analyzerdartdoc depends on itPerforms static analysis of Dart code for tool integration and embedding.
- yamldartdoc depends on itA Dart library for parsing YAML documents into Dart data structures.
- cryptodartdoc depends on itProvides SHA, MD5, and HMAC hashing functions for Dart.
- pub_semverdartdoc depends on itVersions and version constraints implementing pub's versioning policy.
- globdartdoc depends on itA file and directory globbing library that supports Bash-style path matching and listing.
- package_configdartdoc depends on itRead and write Dart package configuration files.
- source_spandartdoc depends on itStandard representation for source code locations, spans, and human-friendly error messages.
- htmldartdoc depends on itA Dart implementation of an HTML5 parser for strings and bytes.