Skip to content
Open
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
5 changes: 5 additions & 0 deletions data/toc-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,11 @@
"examples": [
{
"filename": "howto-commonjs-modules.html"
},
{
"link": "https://github.com/shri/JSDoc-Style-Guide",
"text": "Unofficial JSDoc Style Guide",
"description": "An unofficial JSDoc Style Guide with examples."
}
],
"contribute": [
Expand Down
2 changes: 2 additions & 0 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,8 @@ <h2>JSDoc Examples</h2>
<dl>
<dt><a href="howto-commonjs-modules.html">Document CommonJS Modules</a></dt>
<dd>Documenting code that conforms to the CommonJS module standard.</dd>
<dt><a href="https://github.com/shri/JSDoc-Style-Guide">Unofficial JSDoc Style Guide</a></dt>
<dd>An unofficial JSDoc Style Guide with examples.</dd>
</dl>
<h2>Contribute</h2>
<dl>
Expand Down
2 changes: 1 addition & 1 deletion tags-augments.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ <h2 id="overview">Overview</h2>
<p>The @augments or @extends tag marks a symbol as augmenting another symbol.</p>
<p>While current versions of JavaScript don&#39;t allow classes or subclasses in the same way that class-based languages like Java do, many programmers choose to
think of their code structure in these terms. For this purpose JSDoc provides the @class and @extends tags. If you wish to express a similar relationship between
two symbols, but don&#39;t wish to promote the classical analogy, you can use the @contructor and @augments tags instead.</p>
two symbols, but don&#39;t wish to promote the classical analogy, you can use the @constructor and @augments tags instead.</p>
<h2 id="examples">Examples</h2>
<p>In the example below I wish to document the fact that Ducks are a specialised form of Animal: meaning that Duck instances are like Animal instances which have
been augmented with additional properties.
Expand Down