Skip to content

Commit a89927a

Browse files
committed
remove Mozilla Rhino-related docs (#121)
1 parent 32bb6ed commit a89927a

File tree

4 files changed

+4
-16
lines changed

4 files changed

+4
-16
lines changed

about-commandline.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ <h2>Table of Contents</h2>
6767
<tr>
6868
<td><code>--debug</code>
6969
</td>
70-
<td>Log information that can help debug issues in JSDoc itself. On Rhino, launches the debugger when passed as the first option.</td>
70+
<td>Log information that can help debug issues in JSDoc itself.</td>
7171
</tr>
7272
<tr>
7373
<td><code>-e &lt;value&gt;</code>, <code>--encoding &lt;value&gt;</code>

about-plugins.html

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,7 @@ <h3 id="event-handlers">Event Handlers</h3>
7979
};
8080
</code></pre>
8181
</figure>
82-
<p>On Node.js, JSDoc fires events in the same order as the underlying code. On Mozilla Rhino, JSDoc fires all of the <code>jsdocCommentFound</code> events at once
83-
as soon as it starts parsing a file; all other events are fired in the same order as the underlying code.</p>
82+
<p>JSDoc fires events in the same order as the underlying code.</p>
8483
<p>An event-handler plugin can stop later plugins from running by setting a <code>stopPropagation</code> property on the event object (<code>e.stopPropagation = true</code>).
8584
A plugin can stop the event from firing by setting a <code>preventDefault</code> property (<code>e.preventDefault = true</code>).</p>
8685
<h4 id="event-parsebegin">Event: parseBegin</h4>
@@ -282,9 +281,6 @@ <h3 id="node-visitors">Node Visitors</h3>
282281
<li><code>parser</code>: The JSDoc parser instance.</li>
283282
<li><code>currentSourceName</code>: The name of the file being parsed.</li>
284283
</ul>
285-
<p>If you run JSDoc on Mozilla Rhino, you can also export a <code>nodeVisitor</code> object that contains a
286-
<code>visitNode</code> function. The <code>visitNode</code> function receives the same parameters as for <code>astNodeVisitor</code> objects, but the <code>node</code> parameter is a Rhino AST node, which is a Java object, rather than an Esprima-style JavaScript object. Rhino node visitors are deprecated as of JSDoc 3.3.0,
287-
and support will be removed in a future version of JSDoc.</p>
288284
<h4 id="making-things-happen">Making things happen</h4>
289285
<p>The primary reasons to implement a node visitor are to be able to document things that aren&#39;t normally documented (like function calls that create classes)
290286
or to auto generate documentation for code that isn&#39;t documented. For instance, a plugin might look for calls to a <code>_trigger</code> method since it

content/en/about-commandline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Option|Description
2424
`-a <value>`, `--access <value>`|Only display symbols with the given `access` property: `private`, `protected`, `public`, or `undefined`, or `all` for all access levels. By default, all except `private` symbols are shown.
2525
`-c <value>`, `--configure <value>`|The path to a JSDoc [configuration file][config-file]. Defaults to `conf.json` or `conf.json.EXAMPLE` in the directory where JSDoc is installed.
2626
`-d <value>`, `--destination <value>`|The path to the output folder for the generated documentation. For JSDoc's built-in Haruki template, use `console` to dump data to the console. Defaults to `./out`.
27-
`--debug`|Log information that can help debug issues in JSDoc itself. On Rhino, launches the debugger when passed as the first option.
27+
`--debug`|Log information that can help debug issues in JSDoc itself.
2828
`-e <value>`, `--encoding <value>`|Assume this encoding when reading all source files. Defaults to `utf8`.
2929
`-h`, `--help`|Display information about JSDoc's command-line options, then exit.
3030
`--match <value>`|Only run tests whose names contain `value`.

content/en/about-plugins.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,7 @@ exports.handlers = {
5757
```
5858
{% endexample %}
5959

60-
On Node.js, JSDoc fires events in the same order as the underlying code. On Mozilla Rhino, JSDoc
61-
fires all of the `jsdocCommentFound` events at once as soon as it starts parsing a file; all other
62-
events are fired in the same order as the underlying code.
60+
JSDoc fires events in the same order as the underlying code.
6361

6462
An event-handler plugin can stop later plugins from running by setting a `stopPropagation` property
6563
on the event object (`e.stopPropagation = true`). A plugin can stop the event from firing by setting
@@ -344,12 +342,6 @@ empty object on which to set various properties.
344342
+ `parser`: The JSDoc parser instance.
345343
+ `currentSourceName`: The name of the file being parsed.
346344

347-
If you run JSDoc on Mozilla Rhino, you can also export a `nodeVisitor` object that contains a
348-
`visitNode` function. The `visitNode` function receives the same parameters as for `astNodeVisitor`
349-
objects, but the `node` parameter is a Rhino AST node, which is a Java object, rather than an
350-
Esprima-style JavaScript object. Rhino node visitors are deprecated as of JSDoc 3.3.0, and support
351-
will be removed in a future version of JSDoc.
352-
353345
[esprima-parser]: http://esprima.org/demo/parse.html
354346

355347
#### Making things happen

0 commit comments

Comments
 (0)