Skip to content

Latest commit

 

History

History
90 lines (90 loc) · 8.05 KB

Tags.md

File metadata and controls

90 lines (90 loc) · 8.05 KB
JSDuck JSDoc Description
abstract abstract (aka @virtual) This member must be implemented (or overridden) by the inheritor.
access Specify the access level of this member (private, public, or protected).
accessor
alias Treat a member as if it had a different name.
alias
alternateClassName
augments (aka @extends) This object adds onto a parent object.
aside
author author Identify the author of an item.
borrows This object uses something from another object.
callback Document a callback function.
category
cfg
chainable
constructor class (aka @constructor) This function is intended to be called with the "new" keyword.
class classdesc Use the following text to describe the entire class.
constant (aka @const) Document an object as a constant.
constructs This function member will be the constructor for the previous class.
copyright Document some copyright information.
default (aka @defaultvalue) Document the default value.
deprecated deprecated Document that this is no longer the preferred way.
description (aka @desc) Describe a symbol.
docauthor
enum enum Document a collection of related properties.
event event Document an event.
evented
example example Provide an example of how to use a documented item.
exports Identify the member that is exported by a JavaScript module.
experimental
extends
external (aka @host) Document an external class/namespace/module.
file (aka @fileoverview, @overview) Describe a file.
fires fires (aka @emits) Describe the events this method may fire.
ftype
function (aka @func, @method) Describe a function or method.
global Document a global object.
hide
ignore ignore Remove this from the final output.
inheritable
inner Document an inner object.
inheritdoc
instance Document an instance member.
kind What kind of symbol is this?
lends Document properties on an object literal as if they belonged to a symbol with a given name.
license Document the software license that applies to this code.
link link Inline tag - create a link.
localdoc
markdown
member (aka @var) Document a member.
member Document properties on an object literal as if they belonged to a symbol with a given name.
memberof This symbol belongs to a parent symbol.
method
mixins mixes This object mixes in all the members from another object.
mixin Document a mixin object.
module Document a JavaScript module.
name Document the name of an object.
namespace Document a namespace object.
new
override
param param (aka @arg, @argument) Document the parameter to a function.
preventable
private private This symbol is meant to be private.
property property (aka @prop) Document a property of an object.
protected protected This member is meant to be protected.
public This symbol is meant to be public.
ptype
readonly readonly This symbol is meant to be read-only.
removed
requires requires This file requires a JavaScript module.
return returns (aka @return) Document the return value of a function.
scss mixin
see Refer to some other documentation for more information.
since since When was this feature added?
singleton
static static Document a static member.
summary A shorter version of the full description.
template
this What does the 'this' keyword refer to here?
throws throws (aka @exception) Describe what errors could be thrown.
todo Document tasks to be completed.
tutorial Insert a link to an included tutorial file.
type type Document the type of an object.
typedef Document a custom type.
uses
var Distinguish different objects with the same name.
variation
version Documents the version number of an item.
xtype