mirror of
https://github.com/flutter/flutter
synced 2024-08-27 12:00:58 +00:00
094f93dfcf
When converting all of the samples to use the snippet tool, I encountered some bugs/shortcomings: 1. The document production took 90 minutes, since the snippet tool was being invoked from the command line each time. I fixed this by snapshotting the executable before running, so it's down to 7 minutes. 2. The sample code was not being properly escaped by the snippet tool, so generics were causing issues in the HTML output. It is now quoted. 3. Code examples that used languages other than Dart were not supported. Anything that highlight.js was compiled for dartdoc with is now supported. 4. The comment color for highlight.js was light grey on white, which was pretty unreadable. It's now dark green and bold.
12 lines
683 B
YAML
12 lines
683 B
YAML
# This file is used by dartdoc when generating API documentation for Flutter.
|
|
dartdoc:
|
|
# Before you can run dartdoc, the snippets tool needs to have a snapshot built.
|
|
# The dev/tools/dartdoc.dart script does this automatically.
|
|
tools:
|
|
snippet:
|
|
command: ["bin/cache/dart-sdk/bin/dart", "../../bin/cache/snippets.snapshot", "--type=application"]
|
|
description: "Creates application sample code documentation output from embedded documentation samples."
|
|
sample:
|
|
command: ["bin/cache/dart-sdk/bin/dart", "../../bin/cache/snippets.snapshot", "--type=sample"]
|
|
description: "Creates sample code documentation output from embedded documentation samples."
|