diff --git a/data/toc-data.json b/data/toc-data.json index adbe4e90..53f0bedc 100644 --- a/data/toc-data.json +++ b/data/toc-data.json @@ -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": [ diff --git a/index.html b/index.html index 0244c851..8aeb842d 100644 --- a/index.html +++ b/index.html @@ -49,6 +49,8 @@

JSDoc Examples

Document CommonJS Modules
Documenting code that conforms to the CommonJS module standard.
+
Unofficial JSDoc Style Guide
+
An unofficial JSDoc Style Guide with examples.

Contribute

diff --git a/tags-augments.html b/tags-augments.html index 19cff91f..4ba256bd 100644 --- a/tags-augments.html +++ b/tags-augments.html @@ -51,7 +51,7 @@

Overview

The @augments or @extends tag marks a symbol as augmenting another symbol.

While current versions of JavaScript don'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't wish to promote the classical analogy, you can use the @contructor and @augments tags instead.

+ two symbols, but don't wish to promote the classical analogy, you can use the @constructor and @augments tags instead.

Examples

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.