docs(): add usage tag

Closes #685
This commit is contained in:
mhartington
2015-12-03 11:38:39 -05:00
parent 411966a491
commit 0d5efe6658
2 changed files with 9 additions and 1 deletions

View File

@ -1,3 +1,4 @@
module.exports = [ module.exports = [
{'name': 'demo'}, {'name': 'demo'},
{'name': 'usage'}
]; ];

View File

@ -115,6 +115,13 @@ docType: "<$ doc.docType $>"
<@ block description @> <@ block description @>
<$ doc.description | marked $> <$ doc.description | marked $>
<@ endblock @> <@ endblock @>
<@ if doc.usage @>
<@ block usage @>
<$ doc.usage | marked $>
<@ endblock @>
<@ endif @>
<h1 class="class export"><$ doc.name $> <span class="type"><$ doc.docType $></span></h1> <h1 class="class export"><$ doc.name $> <span class="type"><$ doc.docType $></span></h1>
<p class="module">exported from {@link <$ doc.moduleDoc.id $> <$doc.moduleDoc.id $> }<br/> <p class="module">exported from {@link <$ doc.moduleDoc.id $> <$doc.moduleDoc.id $> }<br/>
defined in <$ githubViewLink(doc) $> defined in <$ githubViewLink(doc) $>
@ -155,7 +162,7 @@ defined in <$ githubViewLink(doc) $>
<@ endfor -@> <@ endfor -@>
<@- endif -@> <@- endif -@>
<@ if doc.properties @> <@ if doc.properties @>
<h2>Attributes:</h2> <h2>Attributes:</h2>
<table class="table" style="margin:0;"> <table class="table" style="margin:0;">
<thead> <thead>