JSDoc Filter

The JSDoc Filter in JS/UML parses JavaScript based on JSDoc style commented JavaScript.

Packages

• packages can be created by specifying the @namespace tag

• otherwise packages are created from the relative path from the source root to the given source file

Classes

• classes are defined with the @class tag

• classes can be designated as @abstract. The @abstract is not supported in JSDoc.

• superclasses can be designated with the @extends tag

Properties

• defined and named by the @property tag

• can by typed via the @type tag

Methods

• defined and named by the @method, @function, @func tags

• support for @static and @abstract

• visibility restricted via @private or @protected

• @param tags define parameter names and types

• the @return tag defines the return type