mirror of
https://github.com/flutter/flutter
synced 2024-09-12 21:01:59 +00:00
65d3ddd5d1
This creates a custom dartdoc tool that will generate snippet blocks in our API docs that allow the user to copy easily to the clipboard, and will also embed the snippet code into a template to show it in a larger context with an app. This PR adds the snippet tool, a template, and a couple of HTML skeleton files, one for snippets that are designed to be in an application setting, and one where it simply puts a nice container around existing snippets, making them easier to copy to the clipboard.
10 lines
462 B
YAML
10 lines
462 B
YAML
# This file is used by dartdoc when generating API documentation for Flutter.
|
|
dartdoc:
|
|
tools:
|
|
snippet:
|
|
command: ["dev/snippets/lib/main.dart", "--type=application"]
|
|
description: "Creates application sample code documentation output from embedded documentation samples."
|
|
sample:
|
|
command: ["dev/snippets/lib/main.dart", "--type=sample"]
|
|
description: "Creates sample code documentation output from embedded documentation samples."
|