From 0d5efe66585a84255bda12933b4e3c48b950f87d Mon Sep 17 00:00:00 2001 From: mhartington Date: Thu, 3 Dec 2015 11:38:39 -0500 Subject: [PATCH] docs(): add usage tag Closes #685 --- scripts/docs/tag-defs/tag-defs.js | 1 + scripts/docs/templates/common.template.html | 9 ++++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/scripts/docs/tag-defs/tag-defs.js b/scripts/docs/tag-defs/tag-defs.js index 6e924159d7..ca0dabb314 100644 --- a/scripts/docs/tag-defs/tag-defs.js +++ b/scripts/docs/tag-defs/tag-defs.js @@ -1,3 +1,4 @@ module.exports = [ {'name': 'demo'}, + {'name': 'usage'} ]; diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index 38c30bfec6..a4f34a9e69 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -115,6 +115,13 @@ docType: "<$ doc.docType $>" <@ block description @> <$ doc.description | marked $> <@ endblock @> + +<@ if doc.usage @> +<@ block usage @> +<$ doc.usage | marked $> +<@ endblock @> +<@ endif @> +

<$ doc.name $> <$ doc.docType $>

exported from {@link <$ doc.moduleDoc.id $> <$doc.moduleDoc.id $> }
defined in <$ githubViewLink(doc) $> @@ -155,7 +162,7 @@ defined in <$ githubViewLink(doc) $> <@ endfor -@> <@- endif -@> -<@ if doc.properties @> +<@ if doc.properties @>

Attributes: