Skip to content

Commit

Permalink
feat(output): Display type information for typedefs in Markdown and HTML
Browse files Browse the repository at this point in the history 
This is a follow-up commit because I didn't format the original commit message properly and didn't

want to ammend master.
  • Loading branch information
@tmcw
tmcw committed Nov 25, 2016
1 parent f9ddb9c commit 8b04029
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 70 deletions.
2 changes: 0 additions & 2 deletions default_theme/section._
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,12 @@
<%= md(section.description) %>

<div class='pre p1 fill-light mt0'><%= signature(section) %></div>

<% if (section.type) { %>
<p>
Type:
<%= formatType(section.type) %>
</p>
<% } %>

<% if (section.augments) { %>
<p>
Extends
Expand Down
34 changes: 0 additions & 34 deletions test/fixture/html/nested.config-output.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,9 +256,7 @@ <h3 class='fl m0' id='klass'>


<div class='pre p1 fill-light mt0'>new Klass(foo: any)</div>




<p>
Extends
Expand Down Expand Up @@ -319,9 +317,7 @@ <h3 class='fl m0' id='klass'>


<div class='pre p1 fill-light mt0'>isClass(other: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, also: any): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>






Expand Down Expand Up @@ -396,9 +392,7 @@ <h3 class='fl m0' id='klass'>


<div class='pre p1 fill-light mt0'>isWeird(other: Weird): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>






Expand Down Expand Up @@ -464,9 +458,7 @@ <h3 class='fl m0' id='klass'>


<div class='pre p1 fill-light mt0'>isBuffer(buf: (<a href="https://nodejs.org/api/buffer.html">Buffer</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>), size: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>?): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>






Expand Down Expand Up @@ -542,9 +534,7 @@ <h3 class='fl m0' id='klass'>


<div class='pre p1 fill-light mt0'>isArrayOfBuffers(buffers: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;<a href="https://nodejs.org/api/buffer.html">Buffer</a>>): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></div>






Expand Down Expand Up @@ -618,9 +608,7 @@ <h3 class='fl m0' id='klass'>


<div class='pre p1 fill-light mt0'>MAGIC_NUMBER</div>






Expand Down Expand Up @@ -665,9 +653,7 @@ <h3 class='fl m0' id='klass'>


<div class='pre p1 fill-light mt0'>event</div>






Expand Down Expand Up @@ -720,9 +706,7 @@ <h3 class='fl m0' id='klass'>


<div class='pre p1 fill-light mt0'>getFoo(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></div>






Expand Down Expand Up @@ -782,9 +766,7 @@ <h3 class='fl m0' id='klass'>


<div class='pre p1 fill-light mt0'>withOptions(options: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, otherOptions: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>?)</div>






Expand Down Expand Up @@ -889,9 +871,7 @@ <h3 class='fl m0' id='customerror'>


<div class='pre p1 fill-light mt0'>CustomError</div>






Expand Down Expand Up @@ -965,9 +945,7 @@ <h3 class='fl m0' id='bar'>


<div class='pre p1 fill-light mt0'>bar(): <a href="#klass">Klass</a></div>






Expand Down Expand Up @@ -1021,9 +999,7 @@ <h3 class='fl m0' id='bar'>


<div class='pre p1 fill-light mt0'>bar(toys: ...<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>






Expand Down Expand Up @@ -1092,9 +1068,7 @@ <h3 class='fl m0' id='bar'>


<div class='pre p1 fill-light mt0'>bar(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>






Expand Down Expand Up @@ -1148,9 +1122,7 @@ <h3 class='fl m0' id='foo'>


<div class='pre p1 fill-light mt0'>new Foo()</div>






Expand Down Expand Up @@ -1191,9 +1163,7 @@ <h3 class='fl m0' id='foo'>


<div class='pre p1 fill-light mt0'>bar</div>






Expand Down Expand Up @@ -1249,9 +1219,7 @@ <h3 class='fl m0' id='customstreams'>


<div class='pre p1 fill-light mt0'>customStreams</div>






Expand Down Expand Up @@ -1290,9 +1258,7 @@ <h3 class='fl m0' id='customstreams'>


<div class='pre p1 fill-light mt0'>new passthrough()</div>






Expand Down
34 changes: 0 additions & 34 deletions test/fixture/html/nested.output.files
View file
Original file line number Diff line number Diff line change
Expand Up @@ -218,9 +218,7 @@


<div class='pre p1 fill-light mt0'>new Klass(foo: any)</div>




<p>
Extends
Expand Down Expand Up @@ -281,9 +279,7 @@ This is a [link to something that does not exist]<a href="DoesNot">DoesNot</a></


<div class='pre p1 fill-light mt0'>isClass(other: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, also: any): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>






Expand Down Expand Up @@ -358,9 +354,7 @@ the referenced class type</p>


<div class='pre p1 fill-light mt0'>isWeird(other: Weird): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>






Expand Down Expand Up @@ -426,9 +420,7 @@ the referenced class type</p>


<div class='pre p1 fill-light mt0'>isBuffer(buf: (<a href="https://nodejs.org/api/buffer.html">Buffer</a> | <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>), size: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>?): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">boolean</a></div>






Expand Down Expand Up @@ -504,9 +496,7 @@ the referenced class type</p>


<div class='pre p1 fill-light mt0'>isArrayOfBuffers(buffers: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;<a href="https://nodejs.org/api/buffer.html">Buffer</a>>): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a></div>






Expand Down Expand Up @@ -580,9 +570,7 @@ k.isArrayOfBuffers();</pre>


<div class='pre p1 fill-light mt0'>MAGIC_NUMBER</div>






Expand Down Expand Up @@ -627,9 +615,7 @@ k.isArrayOfBuffers();</pre>


<div class='pre p1 fill-light mt0'>event</div>






Expand Down Expand Up @@ -682,9 +668,7 @@ k.isArrayOfBuffers();</pre>


<div class='pre p1 fill-light mt0'>getFoo(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a></div>






Expand Down Expand Up @@ -744,9 +728,7 @@ k.isArrayOfBuffers();</pre>


<div class='pre p1 fill-light mt0'>withOptions(options: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">Object</a>, otherOptions: <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">number</a>?)</div>






Expand Down Expand Up @@ -851,9 +833,7 @@ k.isArrayOfBuffers();</pre>


<div class='pre p1 fill-light mt0'>CustomError</div>






Expand Down Expand Up @@ -927,9 +907,7 @@ like a <a href="#klass">klass</a></p>


<div class='pre p1 fill-light mt0'>bar(): <a href="#klass">Klass</a></div>






Expand Down Expand Up @@ -983,9 +961,7 @@ like a <a href="#klass">klass</a></p>


<div class='pre p1 fill-light mt0'>bar(toys: ...<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">Number</a>): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>






Expand Down Expand Up @@ -1054,9 +1030,7 @@ like a <a href="#klass">klass</a>. This needs a <a href="https://developer.mozil


<div class='pre p1 fill-light mt0'>bar(): <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">undefined</a></div>






Expand Down Expand Up @@ -1110,9 +1084,7 @@ like a <a href="#klass">klass</a>. This needs a <a href="https://developer.mozil


<div class='pre p1 fill-light mt0'>new Foo()</div>






Expand Down Expand Up @@ -1153,9 +1125,7 @@ like a <a href="#klass">klass</a>. This needs a <a href="https://developer.mozil


<div class='pre p1 fill-light mt0'>bar</div>






Expand Down Expand Up @@ -1211,9 +1181,7 @@ like a <a href="#klass">klass</a>. This needs a <a href="https://developer.mozil


<div class='pre p1 fill-light mt0'>customStreams</div>






Expand Down Expand Up @@ -1252,9 +1220,7 @@ like a <a href="#klass">klass</a>. This needs a <a href="https://developer.mozil


<div class='pre p1 fill-light mt0'>new passthrough()</div>






Expand Down

0 comments on commit 8b04029

Please sign in to comment.