Skip to content

Filled out remaining tags documentation. #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 43 commits into from
Apr 8, 2013
Merged

Filled out remaining tags documentation. #15

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
3a38673
Added @abstract page
mathematicalcoffee Feb 5, 2013
6cd56c8
added @access documentation
mathematicalcoffee Feb 5, 2013
4571ab0
added @private documentation
mathematicalcoffee Feb 5, 2013
97f05bd
filled out @public
mathematicalcoffee Feb 5, 2013
39c94b9
filled out @protected
mathematicalcoffee Feb 5, 2013
cb9c81d
filled out @instance documentation
mathematicalcoffee Feb 5, 2013
3fe4ebe
filled out @inner documentation
mathematicalcoffee Feb 5, 2013
210331c
added @static page
mathematicalcoffee Feb 5, 2013
02b5b5d
added links to @inner, @instance, @static in tags-global.
mathematicalcoffee Feb 5, 2013
f90147b
added page and documentation for @alias
mathematicalcoffee Feb 5, 2013
5164760
added documentation for @since and linked tags-version to it.
mathematicalcoffee Feb 5, 2013
d8e7d42
Added documentation for @readonly
mathematicalcoffee Feb 5, 2013
663fec0
added @variation page and documentation
mathematicalcoffee Feb 5, 2013
646b344
@typedef doc
mathematicalcoffee Feb 5, 2013
5b83389
Added examples to @param on parameters that are objects with specifie…
mathematicalcoffee Feb 5, 2013
e486be0
filled out @namespace
mathematicalcoffee Feb 5, 2013
215bb84
filled out @module page
mathematicalcoffee Feb 5, 2013
b9bfd6b
added additional example to @constant demonstrating @constant {type}
mathematicalcoffee Feb 5, 2013
8824071
added @defaultvalue as synonym for @default
mathematicalcoffee Feb 5, 2013
7306e48
added @description as a synonym for @desc + link to @summary
mathematicalcoffee Feb 5, 2013
31fe4e0
@example: added note about <caption> feature.
mathematicalcoffee Feb 5, 2013
165e2e9
@external: added doc
mathematicalcoffee Feb 5, 2013
7b0bf27
@file: added @fileOvervie and @overview as synonyms
mathematicalcoffee Feb 5, 2013
8d98f99
@kind: filled out doc
mathematicalcoffee Feb 5, 2013
bb4bb85
@link: removed the [IN PROGRESS] part of the page description
mathematicalcoffee Feb 5, 2013
cbfe471
@member: filled out documentation
mathematicalcoffee Feb 5, 2013
970362d
@memberof: added doc
mathematicalcoffee Feb 5, 2013
d30b883
@method: filled out documentation
mathematicalcoffee Feb 5, 2013
4e8eb4e
@mixes: added documentation
mathematicalcoffee Feb 5, 2013
fc7bcc3
@mixin: filled out doc
mathematicalcoffee Feb 5, 2013
3fbdd23
@name: filled out documentation
mathematicalcoffee Feb 5, 2013
4c97464
@property: added synonym @prop
mathematicalcoffee Feb 5, 2013
c04def5
@requires: added doc
mathematicalcoffee Feb 5, 2013
be473ac
@returns: added synonym @return
mathematicalcoffee Feb 5, 2013
08c9538
@see: filled out documentation
mathematicalcoffee Feb 5, 2013
4ad29f6
@summary: filled out documentation
mathematicalcoffee Feb 5, 2013
d9245ff
@this: filled out documentation
mathematicalcoffee Feb 5, 2013
da0396f
@throws: filled out documentation
mathematicalcoffee Feb 5, 2013
df5f1cf
@todo: filled out documentation
mathematicalcoffee Feb 5, 2013
9213154
@type: added documentation
mathematicalcoffee Feb 5, 2013
5d01c3f
fix broken link
mathematicalcoffee Feb 5, 2013
3b27de3
@module and @namespace can have types: added example for these
mathematicalcoffee Feb 6, 2013
452952d
added notes about the ability to quote longnames in the relevant arti…
mathematicalcoffee Feb 6, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
@requires: added doc
  • Loading branch information
@mathematicalcoffee
mathematicalcoffee committed Feb 5, 2013
commit c04def5033fb8a9599e45fbaff8e322ca7e7d1b8
27 changes: 15 additions & 12 deletions Jake/articles/tags-requires
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
<!--{
"title": "@requires",
"out": "tags-requires.html",
"description": "[todo] This JavaScript module requires another JavaScript module."
"description": "This JavaScript module requires another JavaScript module."
}-->
<h3>Syntax</h3>
<code>@requires &lt;someModuleName&gt;</code>

<h3>Overview</h3>

<p>The @requires tag allows you to document that a module that is needed to use this code.
A doclet can have multiple @requires. The module name can be specified as "moduleName" or "module:moduleName"; both forms will be interpreted as modules.
</p>
<p>
Note this is for the purpose of documentation only - JSDoc won't "include" it in any way when it does its parsing.
</p>

<h3>Examples</h3>

<p>
</p>

{{#example}}Example goes here
// todo
{{#example}}Usage of @requires.
/** This will require module:foo/helper and module:foo/helper~Foo#bar.
* @requires module:foo/helper
* @requires foo/helper~Foo#bar this text will be ignored
*/
function bar() {
}
{{/example}}

<h3>See Also</h3>

<ul>
<li><a href="#">...</a></li>
</ul>
2 changes: 1 addition & 1 deletion index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ <h2 name="JSDoc3_Tag_Dictionary" id="JSDoc3_Tag_Dictionary">JSDoc 3 Tag Dictiona
<dd>This object is a member or another object.</dd> <dt><a href="tags-constructor.html">@constructor</a></dt>
<dd>This function is intended to be called with the &quot;new&quot; keyword.</dd> <dt><a href="tags-link.html">@link</a></dt>
<dd>Inline tag - create a link.</dd> <dt><a href="tags-requires.html">@requires</a></dt>
<dd>[todo] This JavaScript module requires another JavaScript module.</dd> <dt><a href="tags-version.html">@version</a></dt>
<dd>This JavaScript module requires another JavaScript module.</dd> <dt><a href="tags-version.html">@version</a></dt>
<dd>Documents the version number of an item.</dd> <dt><a href="tags-throws.html">@throws</a></dt>
<dd>[todo] Describe what errors could be thrown.</dd> <dt><a href="tags-classdesc.html">@classdesc</a></dt>
<dd>Use the following text to describe the entire class.</dd> <dt><a href="tags-author.html">@author</a></dt>
Expand Down
27 changes: 16 additions & 11 deletions tags-requires.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="description" content="[todo] This JavaScript module requires another JavaScript module."><title>Use JSDoc: @requires</title>
<meta name="description" content="This JavaScript module requires another JavaScript module."><title>Use JSDoc: @requires</title>

<link rel="stylesheet" href="lib/prettify.css" />
<script src="lib/prettify.js"></script>
Expand Down Expand Up @@ -176,29 +176,34 @@
<article>
<h1>@requires</h1>

<h3>Syntax</h3>
<code>@requires &lt;someModuleName&gt;</code>

<h3>Overview</h3>

<p>The @requires tag allows you to document that a module that is needed to use this code.
A doclet can have multiple @requires. The module name can be specified as "moduleName" or "module:moduleName"; both forms will be interpreted as modules.
</p>
<p>
Note this is for the purpose of documentation only - JSDoc won't "include" it in any way when it does its parsing.
</p>

<h3>Examples</h3>

<p>
</p>

<dl class="example">
<dt>Example goes here</dt>
<dt>Usage of @requires.</dt>
<dd>
<pre class="prettyprint lang-js">
// todo
/** This will require module:foo/helper and module:foo/helper~Foo#bar.
* @requires module:foo/helper
* @requires foo/helper~Foo#bar this text will be ignored
*/
function bar() {
}

</pre>
</dd>
</dl><h3>See Also</h3>

<ul>
<li><a href="#">...</a></li>
</ul>
</dl>
</article>

<footer>
Expand Down