@since

May 18, 2022 0 Comments

Syntax @since versionDescription Overview The @since tag indicates that a class, method, or other symbol was added in a specific version. Examples Using the @since tag /**  * Provides access to user information.  * @since 1.0.1  */ function UserRecord() {} See Also @version

Testing JSDoc 3

May 18, 2022 0 Comments

Running Tests Running tests is easy. Just change your working directory to the jsdoc folder and run the following command on Windows: Example jsdoc -T … or on a Max OSX or *nix platform: Example ./jsdoc -T If you can’t get the short-form commands to work, try invoking Java directly: Example java -cp lib/js.jar org.mozilla.javascript.tools.shell.Main …

Inline tags

May 18, 2022 0 Comments

Table of Contents Links to other symbols {@link} Configuring {@link} output {@linkplain} {@linkcode} Links to tutorials: {@tutorial} See also JSDoc has several tags that can be used within a tag description. You can use these tags to create links or cross-references to other parts of the documentation: {@link}: Link to a JSDoc namepath or an external URL. …

@method

May 18, 2022 0 Comments

Synonyms @function @func Syntax @method [<FunctionName>] @func [<FunctionName>] @function [<FunctionName>] Overview This marks an object as being a function, even though it may not appear to be one to the parser. It sets the doclet’s @kind to ‘function’. Examples Using @function to mark a function. /** @function */ var paginate = paginateFactory(pages); Without the @function tag, the paginate object would be …

Readme

May 18, 2022 0 Comments

JSDoc 3 An inline API documentation processor for JavaScript. JSDoc 3 is intended to be an upgrade to JsDoc Toolkit (JSDoc 2). Pull Requesters: Please read HOWTOCONTRIBUTE.md Installation Download a copy of JSDoc 3 from the official GitHub repository here: https://github.com/jsdoc3/jsdoc To test that jsdoc is working, change your working directory to the jsdoc folder and …

@yields

May 18, 2022 0 Comments

Table of Contents Synonyms Syntax Overview Examples Related Links Synonyms @yield Syntax @yields [{type}] [description] Overview The @yields tag documents the value that is yielded by a generator function. This tag is available in JSDoc 3.5.0 and later. If you are documenting a regular function, use the @returns tag instead of this tag. Examples @yields tag with a type/**  * …

@package

May 18, 2022 0 Comments

Table of Contents Syntax Overview Examples Related Links Syntax With the JSDoc tag dictionary (enabled by default): @package With the Closure Compiler tag dictionary: @package [{typeExpression}] Overview The @package tag marks a symbol as package-private. Typically, this tag indicates that a symbol is available only to code in the same directory as the source file for this symbol. This …

JSDoc 3 License

May 18, 2022 0 Comments

License JSDoc 3 is free software, licensed under the Apache License, Version 2.0. Commercial and non-commercial use are permitted in compliance with the License. In addition, JSDoc 3 includes or depends upon several third-party software packages, either in whole or in part. Each third-party software package is provided under its own license. See LICENSE.md for more details about …

Including a Package File

May 18, 2022 0 Comments

Package files contain information that can be useful for your project’s documentation, such as the project’s name and version number. JSDoc can automatically use information from your project’s package.json file when it generates documentation. For example, the default template shows the project’s name and version number in the documentation. There are two ways to incorporate a package.json file into …

{@tutorial}

May 18, 2022 0 Comments

Table of Contents Syntax Overview Examples Related Links Syntax {@tutorial tutorialID} [link text]{@tutorial tutorialID} {@tutorial tutorialID|link text} {@tutorial tutorialID link text (after the first space)} Overview The {@tutorial} inline tag creates a link to the tutorial identifier that you specify. When you use the {@tutorial} tag, you can also provide link text, using one of several different formats. If …