tree: 8f9abc9537864b1292ab552c3426e4bd9a43e683 [path history] [tgz]
  1. BUILD.gn
  2. README.md
  3. analysis_options.yaml
  4. bin/
  5. lib/
  6. pubspec.yaml
  7. test/
tools/doc_checker/README.md

Doc checker

The present tool verifies the structure and content of documentation files.

Features

This tool can generate a graph of the .md files in a given directory. It also checks that HTTP links are valid and do not point to the same project (for which relative links should be preferred). Lastly, it identifies documents which are not connected to the rest of the documentation tree.

Usage

In order to build this tool, add topaz/packages/doc_checker to your build packages. The tool is then available at:

out/x64/dart-tools/doc_checker

See the tool's help for how to hold it right.

In order to view the generated graph, run (on Linux):

dot -Tpng graph.dot -o tree.png && feh tree.png