W3cubDocs

/JSDoc

@class

Table of Contents

Synonyms

@constructor

Syntax

@class [<type> <name>]

Overview

The @class tag marks a function as being a constructor, meant to be called with the new keyword to return an instance.

Examples

A function that constructs Person instances.
/**
 * Creates a new Person.
 * @class
 */
function Person() {
}

var p = new Person();

@constructs

© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
http://usejsdoc.org/tags-class.html