blob: 49db3df517f68c2c693863bfb555408b7c0a05d3 [file] [log] [blame]
Greg Spencer65d3ddd2018-10-23 13:50:24 -07001# This file is used by dartdoc when generating API documentation for Flutter.
2dartdoc:
Greg Spencer094f93d2018-11-07 08:29:14 -08003 # 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 Spencer65d3ddd2018-10-23 13:50:24 -07005 tools:
6 snippet:
Greg Spencerfabf4e32020-01-08 15:28:02 -08007 command: ["dev/snippets/lib/main.dart", "--type=snippet"]
8 description: "Creates sample code documentation output from embedded documentation samples."
Greg Spencer65d3ddd2018-10-23 13:50:24 -07009 sample:
Greg Spencer9d878ca2018-11-27 22:31:49 -080010 command: ["dev/snippets/lib/main.dart", "--type=sample"]
Greg Spencerfabf4e32020-01-08 15:28:02 -080011 description: "Creates full application sample code documentation output from embedded documentation samples."
Andrew Brogdon69197772019-09-10 08:36:14 -070012 dartpad:
Greg Spencerfabf4e32020-01-08 15:28:02 -080013 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."