8000 make extended docs and api easier to integrate · jsdoc/jsdoc.github.io@242a923 · GitHub
[go: up one dir, main page]
Skip to content

Commit 242a923

Browse files
matthewkastormatthewkastor
committed
make extended docs and api easier to integrate
Improved the include tag: Included files can contain mustache tags. Separated article content for tags into Jake\API\describeTags and Jake\extended_docs\tags The API folder is for documentation generated from JSDoc 3. The extended_docs folder is for hand written content. To make it easy we should have the API docs and extended_docs share the same name. Or, in the case of several extending docs, use the API filename as a prefix.
1 parent 1da9249 commit 242a923

File tree

263 files changed

+6327
-2534
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

263 files changed

+6327
-2534
lines changed

‎Jake/API/describeTags/tags-abstract.html

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
1-
<h2>abstract</h2>
2-
<p><br>
3-
<b>title</b> : abstract<br>
4-
<b>mustNotHaveValue</b> : true<br>
5-
<b>onTagged</b> : <br>
6-
</p>
1+
<div class="tags-definition" id="abstract-definition">
2+
<h3 class="tags-name">abstract</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="abstract-title-name"><b>title</b></td> <td class="tags-property-value" id="abstract-title-value">abstract</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="abstract-mustNotHaveValue-name"><b>mustNotHaveValue</b></td> <td class="tags-property-value" id="abstract-mustNotHaveValue-value">true</td>
11+
</tr>
12+
<tr>
13+
<td class="tags-property-name" id="abstract-onTagged-name"><b>onTagged</b></td> <td class="tags-property-value" id="abstract-onTagged-value">
14+
715
<pre class="prettyprint lang-js">
816
function (doclet, tag) {
917
doclet.virtual = true;
1018
}
11-
</pre><p>
12-
<br>
13-
<b>synonyms</b> : virtual<br>
14-
</p><br>
19+
</pre>
20+
21+
</td>
22+
</tr>
23+
<tr>
24+
<td class="tags-property-name" id="abstract-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="abstract-synonyms-value">virtual</td>
25+
</tr>
26+
</tbody></table></div>

‎Jake/API/describeTags/tags-access.html

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
<h2>access</h2>
2-
<p><br>
3-
<b>title</b> : access<br>
4-
<b>mustHaveValue</b> : true<br>
5-
<b>onTagged</b> : <br>
6-
</p>
1+
<div class="tags-definition" id="access-definition">
2+
<h3 class="tags-name">access</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="access-title-name"><b>title</b></td> <td class="tags-property-value" id="access-title-value">access</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="access-mustHaveValue-name"><b>mustHaveValue</b></td> <td class="tags-property-value" id="access-mustHaveValue-value">true</td>
11+
</tr>
12+
<tr>
13+
<td class="tags-property-name" id="access-onTagged-name"><b>onTagged</b></td> <td class="tags-property-value" id="access-onTagged-value">
14+
715
<pre class="prettyprint lang-js">
816
function (doclet, tag) {
917
if (/^(private|protected)$/i.test(tag.value)) {
@@ -12,7 +20,11 @@ <h2>access</h2>
1220
delete doclet.access;
1321
}
1422
}
15-
</pre><p>
16-
<br>
17-
<b>synonyms</b> : <br>
18-
</p><br>
23+
</pre>
24+
25+
</td>
26+
</tr>
27+
<tr>
28+
<td class="tags-property-name" id="access-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="access-synonyms-value"></td>
29+
</tr>
30+
</tbody></table></div>

‎Jake/API/describeTags/tags-alias.html

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
1-
<h2>alias</h2>
2-
<p><br>
3-
<b>title</b> : alias<br>
4-
<b>mustHaveValue</b> : true<br>
5-
<b>onTagged</b> : <br>
6-
</p>
1+
<div class="tags-definition" id="alias-definition">
2+
<h3 class="tags-name">alias</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="alias-title-name"><b>title</b></td> <td class="tags-property-value" id="alias-title-value">alias</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="alias-mustHaveValue-name"><b>mustHaveValue</b></td> <td class="tags-property-value" id="alias-mustHaveValue-value">true</td>
11+
</tr>
12+
<tr>
13+
<td class="tags-property-name" id="alias-onTagged-name"><b>onTagged</b></td> <td class="tags-property-value" id="alias-onTagged-value">
14+
715
<pre class="prettyprint lang-js">
816
function (doclet, tag) {
917
doclet.alias = tag.value;
1018
}
11-
</pre><p>
12-
<br>
13-
<b>synonyms</b> : <br>
14-
</p><br>
19+
</pre>
20+
21+
</td>
22+
</tr>
23+
<tr>
24+
<td class="tags-property-name" id="alias-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="alias-synonyms-value"></td>
25+
</tr>
26+
</tbody></table></div>

‎Jake/API/describeTags/tags-arg.html

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
<h2>arg</h2>
2-
<p><br>
3-
<b>title</b> : arg<br>
4-
<b>synonyms</b> : param<br>
5-
</p><br>
1+
<div class="tags-definition" id="arg-definition">
2+
<h3 class="tags-name">arg</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="arg-title-name"><b>title</b></td> <td class="tags-property-value" id="arg-title-value">arg</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="arg-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="arg-synonyms-value">param</td>
11+
</tr>
12+
</tbody></table></div>

‎Jake/API/describeTags/tags-argument.html

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
<h2>argument</h2>
2-
<p><br>
3-
<b>title</b> : argument<br>
4-
<b>synonyms</b> : param<br>
5-
</p><br>
1+
<div class="tags-definition" id="argument-definition">
2+
<h3 class="tags-name">argument</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="argument-title-name"><b>title</b></td> <td class="tags-property-value" id="argument-title-value">argument</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="argument-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="argument-synonyms-value">param</td>
11+
</tr>
12+
</tbody></table></div>

‎Jake/API/describeTags/tags-augments.html

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,38 @@
1-
<h2>augments</h2>
2-
<p><br>
3-
<b>title</b> : augments<br>
4-
<b>mustHaveValue</b> : true<br>
5-
<b>onTagText</b> : <br>
6-
</p>
1+
<div class="tags-definition" id="augments-definition">
2+
<h3 class="tags-name">augments</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="augments-title-name"><b>title</b></td> <td class="tags-property-value" id="augments-title-value">augments</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="augments-mustHaveValue-name"><b>mustHaveValue</b></td> <td class="tags-property-value" id="augments-mustHaveValue-value">true</td>
11+
</tr>
12+
<tr>
13+
<td class="tags-property-name" id="augments-onTagText-name"><b>onTagText</b></td> <td class="tags-property-value" id="augments-onTagText-value">
14+
715
<pre class="prettyprint lang-js">
816
function (text) {
917
var type = require("jsdoc/tag/type"), tagType = type.getTagInfo(text, false, true);
1018
return tagType.type || text;
1119
}
12-
</pre><p>
13-
<br>
14-
<b>onTagged</b> : <br>
15-
</p>
20+
</pre>
21+
22+
</td>
23+
</tr>
24+
<tr>
25+
<td class="tags-property-name" id="augments-onTagged-name"><b>onTagged</b></td> <td class="tags-property-value" id="augments-onTagged-value">
26+
1627
<pre class="prettyprint lang-js">
1728
function (doclet, tag) {
1829
doclet.augment(firstWordOf(tag.value));
1930
}
20-
</pre><p>
21-
<br>
22-
<b>synonyms</b> : extends<br>
23-
</p><br>
31+
</pre>
32+
33+
</td>
34+
</tr>
35+
<tr>
36+
<td class="tags-property-name" id="augments-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="augments-synonyms-value">extends</td>
37+
</tr>
38+
</tbody></table></div>

‎Jake/API/describeTags/tags-author.html

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,29 @@
1-
<h2>author</h2>
2-
<p><br>
3-
<b>title</b> : author<br>
4-
<b>mustHaveValue</b> : true<br>
5-
<b>onTagged</b> : <br>
6-
</p>
1+
<div class="tags-definition" id="author-definition">
2+
<h3 class="tags-name">author</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="author-title-name"><b>title</b></td> <td class="tags-property-value" id="author-title-value">author</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="author-mustHaveValue-name"><b>mustHaveValue</b></td> <td class="tags-property-value" id="author-mustHaveValue-value">true</td>
11+
</tr>
12+
<tr>
13+
<td class="tags-property-name" id="author-onTagged-name"><b>onTagged</b></td> <td class="tags-property-value" id="author-onTagged-value">
14+
715
<pre class="prettyprint lang-js">
816
function (doclet, tag) {
917
if (!doclet.author) {
1018
doclet.author = [];
1119
}
1220
doclet.author.push(tag.value);
1321
}
14-
</pre><p>
15-
<br>
16-
<b>synonyms</b> : <br>
17-
</p><br>
22+
</pre>
23+
24+
</td>
25+
</tr>
26+
<tr>
27+
<td class="tags-property-name" id="author-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="author-synonyms-value"></td>
28+
</tr>
29+
</tbody></table></div>

‎Jake/API/describeTags/tags-borrows.html

Lines changed: 22 additions & 10 deletions
< 10000 /tr>
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,27 @@
1-
<h2>borrows</h2>
2-
<p><br>
3-
<b>title</b> : borrows<br>
4-
<b>mustHaveValue</b> : true<br>
5-
<b>onTagged</b> : <br>
6-
</p>
1+
<div class="tags-definition" id="borrows-definition">
2+
<h3 class="tags-name">borrows</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="borrows-title-name"><b>title</b></td> <td class="tags-property-value" id="borrows-title-value">borrows</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="borrows-mustHaveValue-name"><b>mustHaveValue</b></td> <td class="tags-property-value" id="borrows-mustHaveValue-value">true</td>
11+
</tr>
12+
<tr>
13+
<td class="tags-property-name" id="borrows-onTagged-name"><b>onTagged</b></td> <td class="tags-property-value" id="borrows-onTagged-value">
14+
715
<pre class="prettyprint lang-js">
816
function (doclet, tag) {
917
var borrows = parseBorrows(doclet, tag);
1018
doclet.borrow(borrows.target, borrows.source);
1119
}
12-
</pre><p>
13-
<br>
14-
<b>synonyms</b> : <br>
15-
</p><br>
20+
</pre>
21+
22+
</td>
23+
</tr>
24+
<tr>
25+
<td class="tags-property-name" id="borrows-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="borrows-synonyms-value"></td>
26+
</tr>
27+
</tbody></table></div>

‎Jake/API/describeTags/tags-class.html

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
<h2>class</h2>
2-
<p><br>
3-
<b>title</b> : class<br>
4-
<b>onTagged</b> : <br>
5-
</p>
1+
<div class="tags-definition" id="class-definition">
2+
<h3 class="tags-name">class</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="class-title-name"><b>title</b></td> <td class="tags-property-value" id="class-title-value">class</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="class-onTagged-name"><b>onTagged</b></td> <td class="tags-property-value" id="class-onTagged-value">
11+
612
<pre class="prettyprint lang-js">
713
function (doclet, tag) {
814
doclet.addTag("kind", "class");
@@ -15,7 +21,11 @@ <h2>class</h2>
1521
}
1622
setDocletNameToValue(doclet, tag);
1723
}
18-
</pre><p>
19-
<br>
20-
<b>synonyms</b> : constructor<br>
21-
</p><br>
24+
</pre>
25+
26+
</td>
27+
</tr>
28+
<tr>
29+
<td class="tags-property-name" id="class-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="class-synonyms-value">constructor</td>
30+
</tr>
31+
</tbody></table></div>

‎Jake/API/describeTags/tags-classdesc.html

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
1-
<h2>classdesc</h2>
2-
<p><br>
3-
<b>title</b> : classdesc<br>
4-
<b>onTagged</b> : <br>
5-
</p>
1+
<div class="tags-definition" id="classdesc-definition">
2+
<h3 class="tags-name">classdesc</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="classdesc-title-name"><b>title</b></td> <td class="tags-property-value" id="classdesc-title-value">classdesc</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="classdesc-onTagged-name"><b>onTagged</b></td> <td class="tags-property-value" id="classdesc-onTagged-value">
11+
612
<pre class="prettyprint lang-js">
713
function (doclet, tag) {
814
doclet.classdesc = tag.value;
915
}
10-
</pre><p>
11-
<br>
12-
<b>synonyms</b> : <br>
13-
</p><br>
16+
</pre>
17+
18+
</td>
19+
</tr>
20+
<tr>
21+
<td class="tags-property-name" id="classdesc-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="classdesc-synonyms-value"></td>
22+
</tr>
23+
</tbody></table></div>

‎Jake/API/describeTags/tags-const.html

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1-
<h2>const</h2>
2-
<p><br>
3-
<b>title</b> : const<br>
4-
<b>synonyms</b> : constant<br>
5-
</p><br>
1+
<div class="tags-definition" id="const-definition">
2+
<h3 class="tags-name">const</h3>
3+
<table><thead>
4+
<tr><th>Property</th> <th>Value</th></tr>
5+
</thead><tbody>
6+
<tr>
7+
<td class="tags-property-name" id="const-title-name"><b>title</b></td> <td class="tags-property-value" id="const-title-value">const</td>
8+
</tr>
9+
<tr>
10+
<td class="tags-property-name" id="const-synonyms-name"><b>synonyms</b></td> <td class="tags-property-value" id="const-synonyms-value">constant</td>
11+
</tr>
12+
</tbody></table></div>

0 commit comments

Comments
 (0)
0