Skip to content

Implemented @ignore #13

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.

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

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,7 @@ Thumbs.db

.rbenv-version
.rvmrc

#IntelliJ Files
.idea/
*.iml
27 changes: 17 additions & 10 deletions Jake/articles/tags-ignore
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
<!--{
"title": "@ignore",
"out": "tags-ignore.html",
"description": "[todo] Remove this from the final output."
"description": "Remove this from the final output."
}-->
<h3>Overview</h3>

<p>
The @ignore tag indicates that an object in your code should be exclude from the documentation,
when it otherwise would be documented.
</p>
<p>
This tag has precedence over any other mechanism, and guarantees that an ignored object will not be documented.
</p>

<h3>Examples</h3>

<p>
Note that in the following example, both Foo and bar will be excluded from the documentation;
when a parent object is ignored, all of its members are also ignored
</p>

{{#example}}Example goes here
// todo
{{/example}}

<h3>See Also</h3>

<ul>
<li><a href="#">...</a></li>
</ul>
{{#example}}Demonstrate how to use @ignore
/**
* @constructor
* @ignore
*/
function Foo() {
this.bar = function() {
}
}{{/example}}
23 changes: 19 additions & 4 deletions Jake/articles/tags-inner
Original file line number Diff line number Diff line change
@@ -1,24 +1,39 @@
<!--{
"title": "@inner",
"out": "tags-inner.html",
"description": "[todo] Document an inner object."
"description": "Document an inner object."
}-->
<h3>Overview</h3>

<p>
Use the @inner tag to indicate the function is an inner function.
Inner functions are declared in the scope of an outer function, and are not directly accessible from outside that outer function.
</p>

<h3>Examples</h3>

<p>
In many cases this tag is not necessary, as JsDoc Toolkit can already recognize the fact that a function is an inner function on its own.
</p>

{{#example}}Example goes here
// todo
{{#example}}
/**
@constructor
*/
Person = function() {
/** @inner */
function daydream() {
}
}
{{/example}}

<p>
Because of the limited scope of the Person function, the daydream function is not directly accessible from outside of Person.
For this reason JsDoc Toolkit will also mark it as <code>@private</code>.
</p>

<h3>See Also</h3>

<ul>
<li><a href="#">...</a></li>
<li><a href="tags-inner.html">@inner</a></li>
</ul>
21 changes: 13 additions & 8 deletions Jake/articles/tags-license
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
<!--{
"title": "@license",
"out": "tags-license.html",
"description": "[todo] Document the software license that applies to this code."
"description": "Document the software license that applies to this code."
}-->

<h3>Syntax</h3>

<code>@license &lt;description&gt;</code>

<h3>Overview</h3>

<p>
The @license tags is used to insert information about the license under which the source code is protected.
</p>

<h3>Examples</h3>
Expand All @@ -14,11 +20,10 @@
</p>

{{#example}}Example goes here
// todo
/**
* @preserve Copyright 2013 SomeCompany LLC
* Here is the full license text and copyright notice for this file.
* Note that the notice can span several
* lines and is only terminated by the closing star and slash:
*/
{{/example}}

<h3>See Also</h3>

<ul>
<li><a href="#">...</a></li>
</ul>
6 changes: 3 additions & 3 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -255,11 +255,11 @@ <h2 name="JSDoc3_Tag_Dictionary" id="JSDoc3_Tag_Dictionary">JSDoc 3 Tag Dictiona
<dd>Describe a file.</dd> <dt><a href="tags-fires.html">@fires</a></dt>
<dd>Describe the events this method may fire.</dd> <dt><a href="tags-global.html">@global</a></dt>
<dd>Document a global object.</dd> <dt><a href="tags-ignore.html">@ignore</a></dt>
<dd>[todo] Remove this from the final output.</dd> <dt><a href="tags-inner.html">@inner</a></dt>
<dd>[todo] Document an inner object.</dd> <dt><a href="tags-instance.html">@instance</a></dt>
<dd>Remove this from the final output.</dd> <dt><a href="tags-inner.html">@inner</a></dt>
<dd>Document an inner object.</dd> <dt><a href="tags-instance.html">@instance</a></dt>
<dd>[todo] Document an instance member.</dd> <dt><a href="tags-kind.html">@kind</a></dt>
<dd>[todo] What kind of object is this?</dd> <dt><a href="tags-license.html">@license</a></dt>
<dd>[todo] Document the software license that applies to this code.</dd> <dt><a href="tags-member.html">@member</a></dt>
<dd>Document the software license that applies to this code.</dd> <dt><a href="tags-member.html">@member</a></dt>
<dd>[todo] Document a member.</dd> <dt><a href="tags-memberof.html">@memberof</a></dt>
<dd>[todo] This object is a member or another object.</dd> <dt><a href="tags-method.html">@method</a></dt>
<dd>[todo] Describe a method or function.</dd> <dt><a href="tags-mixes.html">@mixes</a></dt>
Expand Down
27 changes: 18 additions & 9 deletions tags-ignore.html
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] Remove this from the final output."><title>Use JSDoc: @ignore</title>
<meta name="description" content="Remove this from the final output."><title>Use JSDoc: @ignore</title>

<link rel="stylesheet" href="lib/prettify.css" />
<script src="lib/prettify.js"></script>
Expand Down Expand Up @@ -179,26 +179,35 @@ <h1>@ignore</h1>
<h3>Overview</h3>

<p>
The @ignore tag indicates that an object in your code should be exclude from the documentation,
when it otherwise would be documented.
</p>
<p>
This tag has precedence over any other mechanism, and guarantees that an ignored object will not be documented.
</p>

<h3>Examples</h3>

<p>
Note that in the following example, both Foo and bar will be excluded from the documentation;
when a parent object is ignored, all of its members are also ignored
</p>

<dl class="example">
<dt>Example goes here</dt>
<dt>Demonstrate how to use @ignore</dt>
<dd>
<pre class="prettyprint lang-js">
// todo

/**
* @constructor
* @ignore
*/
function Foo() {
this.bar = function() {
}
}
</pre>
</dd>
</dl><h3>See Also</h3>

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

<footer>
Expand Down
25 changes: 20 additions & 5 deletions tags-inner.html
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] Document an inner object."><title>Use JSDoc: @inner</title>
<meta name="description" content="Document an inner object."><title>Use JSDoc: @inner</title>

<link rel="stylesheet" href="lib/prettify.css" />
<script src="lib/prettify.js"></script>
Expand Down Expand Up @@ -179,25 +179,40 @@ <h1>@inner</h1>
<h3>Overview</h3>

<p>
Use the @inner tag to indicate the function is an inner function.
Inner functions are declared in the scope of an outer function, and are not directly accessible from outside that outer function.
</p>

<h3>Examples</h3>

<p>
In many cases this tag is not necessary, as JsDoc Toolkit can already recognize the fact that a function is an inner function on its own.
</p>

<dl class="example">
<dt>Example goes here</dt>
<dt></dt>
<dd>
<pre class="prettyprint lang-js">
// todo
/**
@constructor
*/
Person = function() {
/** @inner */
function daydream() {
}
}

</pre>
</dd>
</dl><h3>See Also</h3>
</dl><p>
Because of the limited scope of the Person function, the daydream function is not directly accessible from outside of Person.
For this reason JsDoc Toolkit will also mark it as <code>@private</code>.
</p>

<h3>See Also</h3>

<ul>
<li><a href="#">...</a></li>
<li><a href="tags-inner.html">@inner</a></li>
</ul>
</article>

Expand Down
21 changes: 14 additions & 7 deletions tags-license.html
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] Document the software license that applies to this code."><title>Use JSDoc: @license</title>
<meta name="description" content="Document the software license that applies to this code."><title>Use JSDoc: @license</title>

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


<h3>Syntax</h3>

<code>@license &lt;description&gt;</code>

<h3>Overview</h3>

<p>
The @license tags is used to insert information about the license under which the source code is protected.
</p>

<h3>Examples</h3>
Expand All @@ -190,15 +196,16 @@ <h3>Examples</h3>
<dt>Example goes here</dt>
<dd>
<pre class="prettyprint lang-js">
// todo
/**
* @preserve Copyright 2013 SomeCompany LLC
* Here is the full license text and copyright notice for this file.
* Note that the notice can span several
* lines and is only terminated by the closing star and slash:
*/

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

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

<footer>
Expand Down