Skip to content

Commit 5164760

Browse files
added documentation for @SInCE and linked tags-version to it.
1 parent f90147b commit 5164760

File tree

5 files changed

+29
-21
lines changed

5 files changed

+29
-21
lines changed

Jake/articles/tags-since

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,26 @@
11
<!--{
22
"title": "@since",
33
"out": "tags-since.html",
4-
"description": "[todo] When was this feature added?"
4+
"description": "When was this feature added?"
55
}-->
6+
<h3>Syntax</h3>
7+
<code>@since versionDescription</code>
8+
69
<h3>Overview</h3>
710

8-
<p>
11+
<p>The @since tag indicates that a method or property of another class has been added at a given version number.
912
</p>
1013

1114
<h3>Examples</h3>
1215

13-
<p>
14-
</p>
15-
16-
{{#example}}Example goes here
17-
// todo
16+
{{#example}}
17+
/** @since version 1.0.1 */
18+
function foo() {
19+
}
1820
{{/example}}
1921

2022
<h3>See Also</h3>
2123

2224
<ul>
23-
<li><a href="#">...</a></li>
24-
</ul>
25+
<li><a href="tags-version.html">@version</a></li>
26+
</ul>

Jake/articles/tags-version

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,11 @@ method1 = function (a,b) {
3131
<ul>
3232
<li><a href="tags-author.html">@author</a></li>
3333
<li><a href="tags-tutorial.html">@tutorial</a></li>
34+
<li><a href="tags-since.html">@since</a></li>
3435
</ul>
3536

3637
<h5>Contributers to these docs</h5>
3738

3839
<ul>
3940
<li><a href="https://github.com/matthewkastor">matthewkastor</a></li>
40-
</ul>
41+
</ul>

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ <h2 name="JSDoc3_Tag_Dictionary" id="JSDoc3_Tag_Dictionary">JSDoc 3 Tag Dictiona
260260
<dd>Documents the author of an item.</dd> <dt><a href="tags-kind.html">@kind</a></dt>
261261
<dd>[todo] What kind of object is this?</dd> <dt><a href="tags-member.html">@member</a></dt>
262262
<dd>[todo] Document a member.</dd> <dt><a href="tags-since.html">@since</a></dt>
263-
<dd>[todo] When was this feature added?</dd> <dt><a href="tags-access.html">@access</a></dt>
263+
<dd>When was this feature added?</dd> <dt><a href="tags-access.html">@access</a></dt>
264264
<dd>Specify the access level of this member - private, public, or protected.</dd> <dt><a href="tags-borrows.html">@borrows</a></dt>
265265
<dd>This object uses something from another object.</dd> <dt><a href="tags-mixin.html">@mixin</a></dt>
266266
<dd>[todo] Document a mix-in object.</dd> <dt><a href="tags-see.html">@see</a></dt>

tags-since.html

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8">
5-
<meta name="description" content="[todo] When was this feature added?"><title>Use JSDoc: @since</title>
5+
<meta name="description" content="When was this feature added?"><title>Use JSDoc: @since</title>
66

77
<link rel="stylesheet" href="lib/prettify.css" />
88
<script src="lib/prettify.js"></script>
@@ -176,29 +176,32 @@
176176
<article>
177177
<h1>@since</h1>
178178

179+
<h3>Syntax</h3>
180+
<code>@since versionDescription</code>
181+
179182
<h3>Overview</h3>
180183

181-
<p>
184+
<p>The @since tag indicates that a method or property of another class has been added at a given version number.
182185
</p>
183186

184187
<h3>Examples</h3>
185188

186-
<p>
187-
</p>
188-
189189
<dl class="example">
190-
<dt>Example goes here</dt>
190+
<dt></dt>
191191
<dd>
192192
<pre class="prettyprint lang-js">
193-
// todo
193+
/** @since version 1.0.1 */
194+
function foo() {
195+
}
194196

195197
</pre>
196198
</dd>
197199
</dl><h3>See Also</h3>
198200

199201
<ul>
200-
<li><a href="#">...</a></li>
201-
</ul>
202+
<li><a href="tags-version.html">@version</a></li>
203+
</ul>
204+
202205
</article>
203206

204207
<footer>

tags-version.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,13 +208,15 @@ <h3>Examples</h3>
208208
<ul>
209209
<li><a href="tags-author.html">@author</a></li>
210210
<li><a href="tags-tutorial.html">@tutorial</a></li>
211+
<li><a href="tags-since.html">@since</a></li>
211212
</ul>
212213

213214
<h5>Contributers to these docs</h5>
214215

215216
<ul>
216217
<li><a href="https://github.com/matthewkastor">matthewkastor</a></li>
217-
</ul>
218+
</ul>
219+
218220
</article>
219221

220222
<footer>

0 commit comments

Comments
 (0)