zan1456/flutter
1
0
Fork 0
forked from firka/flutter
Code Pull Requests Activity

Dartdoc snippet extension to inject full featured code snippets in to API docs. (#23281)

Browse Source 
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.
This commit is contained in:
Greg Spencer
2018-10-23 13:50:24 -07:00
committed by GitHub
parent a3e0b0aee2
commit 65d3ddd5d1
21 changed files with 1367 additions and 170 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
dartdoc_options.yaml Normal file
View File

@@ -0,0 +1,9 @@
# 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."