Greg Spencer | 65d3ddd | 2018-10-23 13:50:24 -0700 | [diff] [blame] | 1 | # This file is used by dartdoc when generating API documentation for Flutter. |
| 2 | dartdoc: |
Greg Spencer | 094f93d | 2018-11-07 08:29:14 -0800 | [diff] [blame] | 3 | # Before you can run dartdoc, the snippets tool needs to have a snapshot built. |
| 4 | # The dev/tools/dartdoc.dart script does this automatically. |
Greg Spencer | 65d3ddd | 2018-10-23 13:50:24 -0700 | [diff] [blame] | 5 | tools: |
| 6 | snippet: |
Greg Spencer | fabf4e3 | 2020-01-08 15:28:02 -0800 | [diff] [blame] | 7 | command: ["dev/snippets/lib/main.dart", "--type=snippet"] |
| 8 | description: "Creates sample code documentation output from embedded documentation samples." |
Greg Spencer | 65d3ddd | 2018-10-23 13:50:24 -0700 | [diff] [blame] | 9 | sample: |
Greg Spencer | 9d878ca | 2018-11-27 22:31:49 -0800 | [diff] [blame] | 10 | command: ["dev/snippets/lib/main.dart", "--type=sample"] |
Greg Spencer | fabf4e3 | 2020-01-08 15:28:02 -0800 | [diff] [blame] | 11 | description: "Creates full application sample code documentation output from embedded documentation samples." |
Andrew Brogdon | 6919777 | 2019-09-10 08:36:14 -0700 | [diff] [blame] | 12 | dartpad: |
Greg Spencer | fabf4e3 | 2020-01-08 15:28:02 -0800 | [diff] [blame] | 13 | command: ["dev/snippets/lib/main.dart", "--type=sample", "--dartpad"] |
| 14 | description: "Creates full application sample code documentation output from embedded documentation samples and displays it in an embedded DartPad." |