8000 Created `include` mustache tag · anwersayeed/jsdoc.github.io@7365ed5 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7365ed5

Browse files
matthewkastormatthewkastor
committed
Created include mustache tag
created an include tag that simply gets replaced with the contents of a file. This is a quick and dirty patch so I can incorporate the html files output from --describeTags into the documentation. I've only updated one of the files tags-abstract. I don't really like how it looks but I can fix that later. The important part is that it's relatively easy to include this information now.
1 parent 22773a6 commit 7365ed5

Some content is hidden

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

77 files changed

+1042
-1
lines changed

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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>
7+
<pre class="prettyprint lang-js">
8+
function (doclet, tag) {
9+
doclet.virtual = true;
10+
}
11+
</pre><p>
12+
<br>
13+
<b>synonyms</b> : virtual<br>
14+
</p><br>

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
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>
7+
<pre class="prettyprint lang-js">
8+
function (doclet, tag) {
9+
if (/^(private|protected)$/i.test(tag.value)) {
10+
doclet.access = tag.value.toLowerCase();
11+
} else {
12+
delete doclet.access;
13+
}
14+
}
15+
</pre><p>
16+
<br>
17+
<b>synonyms</b> : <br>
18+
</p><br>

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
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>
7+
<pre class="prettyprint lang-js">
8+
function (doclet, tag) {
9+
doclet.alias = tag.value;
10+
}
11+
</pre><p>
12+
<br>
13+
<b>synonyms</b> : <br>
14+
</p><br>

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<h2>arg</h2>
2+
<p><br>
3+
<b>title</b> : arg<br>
4+
<b>synonyms</b> : param<br>
5+
</p><br>

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<h2>argument</h2>
2+
<p><br>
3+
<b>title</b> : argument<br>
4+
<b>synonyms</b> : param<br>
5+
</p><br>

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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>
7+
<pre class="prettyprint lang-js">
8+
function (text) {
9+
var type = require("jsdoc/tag/type"), tagType = type.getTagInfo(text, false, true);
10+
return tagType.type || text;
11+
}
12+
</pre><p>
13+
<br>
14+
<b>onTagged</b> : <br>
15+
</p>
16+
<pre class="prettyprint lang-js">
17+
function (doclet, tag) {
18+
doclet.augment(firstWordOf(tag.value));
19+
}
20+
</pre><p>
21+
<br>
22+
<b>synonyms</b> : extends<br>
23+
</p><br>

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
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>
7+
<pre class="prettyprint lang-js">
8+
function (doclet, tag) {
9+
if (!doclet.author) {
10+
doclet.author = [];
11+
}
12+
doclet.author.push(tag.value);
13+
}
14+
</pre><p>
15+
<br>
16+
<b>synonyms</b> : <br>
17+
</p><br>

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
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>
7+
<pre class="prettyprint lang-js">
8+
function (doclet, tag) {
9+
var borrows = parseBorrows(doclet, tag);
10+
doclet.borrow(borrows.target, borrows.source);
11+
}
12+
</pre><p>
13+
<br>
14+
<b>synonyms</b> : <br>
15+
</p><br>

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<h2>class</h2>
2+
<p><br>
3+
<b>title</b> : class<br>
4+
<b>onTagged</b> : <br>
5+
</p>
6+
<pre class="prettyprint lang-js">
7+
function (doclet, tag) {
8+
doclet.addTag("kind", "class");
9+
if (tag.originalTitle === "class") {
10+
var looksLikeDesc = (tag.value || "").match(/\S+\s+\S+/);
11+
if (looksLikeDesc || /@construct(s|or)\b/i.test(doclet.comment)) {
12+
doclet.classdesc = tag.value;
13+
return;
14+
}
15+
}
16+
setDocletNameToValue(doclet, tag);
17+
}
18+
</pre><p>
19+
<br>
20+
<b>synonyms</b> : constructor<br>
21+
</p><br>

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<h2>classdesc</h2>
2+
<p><br>
3+
<b>title</b> : classdesc<br>
4+
<b>onTagged</b> : <br>
5+
</p>
6+
<pre class="prettyprint lang-js">
7+
function (doclet, tag) {
8+
doclet.classdesc = tag.value;
9+
}
10+
</pre><p>
11+
<br>
12+
<b>synonyms</b> : <br>
13+
</p><br>

0 commit comments

Comments
 (0)
0