Skip to content

for jsdoc3/jsdoc3.github.com#5 - mention jsdoc/util/error in plugin docs #9

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 1 commit into from
Jan 18, 2013
Merged

for jsdoc3/jsdoc3.github.com#5 - mention jsdoc/util/error in plugin docs #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 18 additions & 0 deletions Jake/articles/about-plugins
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@
</a></li>
</ol>
</li>
<li><a href="#throwing-errors">Throwing Errors
</a>
</li>
</ol>
</li>
<li><a href="#packaging-jsdoc-3-plugins">Packaging JSDoc 3 Plugins
Expand Down Expand Up @@ -537,6 +540,21 @@ function isInWidgetFactory(node, depth) {
Lastly, the visitors are executed in the order the plugins are listed in the conf.json file. A plugin can stop later plugins from visiting a node by setting a <code>stopPropagation</code> property on the event object (e.stopPropagation = true). A plugin can stop the event from firing setting a <code>preventDefault</code> property.
</p>

<h3 name="throwing-errors" id="throwing-errors">
Throwing Errors
</h3>
<p>
If you wish your plugin to throw an error, do it using the <code>handle</code> function in the <code>jsdoc/util/error</code> module.
</p>

{{#example}}Example
require('jsdoc/util/error').handle( new Error('I do not like green eggs and ham!') );
{{/example}}

<p>
By default this will throw the error, halting the execution of <code>jsdoc</code>. However, if the user used the <code>--lenient</code> switch when they ran <code>jsdoc</code> it will simply log the error to the console and continue.
</p>

<h2 name="packaging-jsdoc-3-plugins" id="packaging-jsdoc-3-plugins">
Packaging JSDoc 3 Plugins
</h2>
Expand Down
22 changes: 22 additions & 0 deletions about-plugins.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,9 @@ <h1>JSDoc 3 Plugin Reference</h1>
</a></li>
</ol>
</li>
<li><a href="#throwing-errors">Throwing Errors
</a>
</li>
</ol>
</li>
<li><a href="#packaging-jsdoc-3-plugins">Packaging JSDoc 3 Plugins
Expand Down Expand Up @@ -755,6 +758,25 @@ <h4 name="example" id="example">
Lastly, the visitors are executed in the order the plugins are listed in the conf.json file. A plugin can stop later plugins from visiting a node by setting a <code>stopPropagation</code> property on the event object (e.stopPropagation = true). A plugin can stop the event from firing setting a <code>preventDefault</code> property.
</p>

<h3 name="throwing-errors" id="throwing-errors">
Throwing Errors
</h3>
<p>
If you wish your plugin to throw an error, do it using the <code>handle</code> function in the <code>jsdoc/util/error</code> module.
</p>

<dl class="example">
<dt>Example</dt>
<dd>
<pre class="prettyprint lang-js">
require('jsdoc/util/error').handle( new Error('I do not like green eggs and ham!') );

</pre>
</dd>
</dl><p>
By default this will throw the error, halting the execution of <code>jsdoc</code>. However, if the user used the <code>--lenient</code> switch when they ran <code>jsdoc</code> it will simply log the error to the console and continue.
</p>

<h2 name="packaging-jsdoc-3-plugins" id="packaging-jsdoc-3-plugins">
Packaging JSDoc 3 Plugins
</h2>
Expand Down