v0.5.0
Module

Generic

Generic tags, these tags are available in all languages

Tags

Tags

@version

Define a package or module version

Code:

'version': 'setVersion',

@package

Creates a package and groups all folowing anotations to this package

A package can contain a set of subpackages and modules

Code:

'package': 'setTag',
v0.4.7

@subpackage

Creates a subpackage and groups all folowing anotations to this subpackage

A subpackage can contain a set of modules

Example:

/**

Code:

'subpackage': 'setTag',
Module

mymodule

Creates a submodule and groups all folowing anotations to this submodule

Tags

Tags

@module

Creates a module and groups all folowing anotations to this module

A module can contain a set of submodules

Example:

/**

Code:

'module': 'setTag',
Submodule

submodule

Creates a submodule and groups all folowing anotations to this submodule

Tags

Tags

@submodule

Creates a submodule and groups all folowing anotations to this submodule

Example:

/**

Code:

'submodule': 'setTag',

myname

Defines a name for a block

Example:

/**

Code:

'name': setNameTag,

@public

Public

Sets the public flag for a block

Example:

/**

Code:

'public': 'setPublic',

@protected

Protected

Sets the protected flag for a block

Example:

/**

Code:

'protected': 'setProtected',

@private

Private

Sets the private flag for a block

Example:

/**

Code:

'private': 'setPrivate',

@unimplemented

Unimplemented

Marks a block as unimplemented. Passing a version number is optionally

Example:

/**

Code:

'unimplemented': 'setFlag',

@beta

Beta

Marks a block as beta. Passing a version number is optionally

Example:

/**

Code:

'beta': 'setFlag',

@new

New

Marks a block as new. Passing a version number is optionally

Example:

/**

Code:

'new': 'setFlag',

@deprecated

Deprecated

Marks a block as deprecated. Passing a version number is optionally

Example:

/**

Code:

'deprecated': 'setDeprecated',

@example

Defines an example block.

Example:

/**
ar foo = 'Foo';
onsole.log(foo);

Code:

'example': addExampleTag,

@preview

Defines a preview block. The preview content should be valid html

Preview:

#ff0000
lt;/div>

Code:

'preview': addPreviewBlock,

@type

Defines a type for a block

Example:

/**

Code:

'type': 'setTag',

Example:

/**

Code:

'link': addLinkTag,
mygroup

mygroup

@group

Creates a new group and passes block to these group

Example:

/**

Code:

'group': setGroupTag,
Module

Javascript

Javascript specific tags

method

Methods

foo

Descripes function or method params

Params:

PropertyTypeDescription
objobjectFoo object
silentboolOptional silent property

Example:

/**

Code:

'param': setParamTag,

foo

Describes a method

Example:

class MyClass {
/**

* Method foo

Code:

'method': setMethodTag,

foo

Describes a return value of a method or function

Returns:

object
Returns a promise

Example:

/**

Code:

'returns': setReturnTag,
property

Properties

obj

object

Descripes a property

Example:

/**

  • My property

Code:

'property': setPropertyTag,
Tags

Tags

@function

TODO

Example:

/*
*\/

Code:

'function': setMethodTag,

@return

See returns tag

Code:

'return': setReturnTag,

@default

TODO

Example:

/*
*\/

Code:

'default': 'setTag',

@event

Describes an event that can be triggered

Example:

/*
*\/

Code:

'event': setEventTag,

@fires

Describes events that a function or method triggers

Example:

/**

Code:

'fires': setFiresTag,

@arg

Describes the arguments for a event call

Fires:

EventDescription
server.ready
Args:
errobjectServer error or null
resobjectExpress response object

Example:

/**

Code:

'arg': setArgTag,

@async

Async

Marks a block as asyncron

Example:

/**

Code:

'async': 'setFlag',

@chainable

Chainable

Marks a block as chainable

Example:

/**

Code:

'chainable': 'setFlag',

@arg

Describes the arguments for a event call

Fires:

EventDescription
server.ready
Args:
errobjectServer error or null
resobjectExpress response object

Example:

/**

Code:

'static': 'setFlag',

@header

Describes an api header

Example:

/**

Code:

'header': setHeaderTag,

@cookie

Describes an api cookie

Example:

/**

Code:

'cookie': setHeaderTag
mixin

Mixins

requestLogger

Describes a mixin

Params:

PropertyTypeDescription
reqobjectExpress req object
resobjectExpress res object
nextfunctionNext callback

Example:

/**

  • Loggs api requests

Code:

'mixin': setMethodTag,

requestLogger

Describes a middleware function

Params:

PropertyTypeDescription
reqobjectExpress req object
resobjectExpress res object
nextfunctionNext callback

Example:

/**

  • Loggs api requests

Code:

'middleware': setMethodTag,
class

Classes

MyClass

Describes a class

Example:

/**

  • My fancy class

Code:

'class': setMethodTag,
const

Constants

SERVER

string

Describes a constant

Example:

/**

  • Constant title

Code:

'const': setConstTag,
var

Variables

isFoo

boolean

Describes a variable

Example:

/**

  • Variable title

Code:

'var': setConstTag,
constructor

Constructors

ction MyCalss() {<br>/ some code

Describes a class constructor

Example:

/**

  • Class constructor

Code:

'constructor': setConstructorTag,
returnValue

returnValue

promise

Detailed description of a return value

Example:

/**

Code:

'returnValue': setReturnValueTag,

promise

Describes an error argument for an event or function call

Example:

/**

Code:

'err': setArgTag,
callback

Callbacks

done

Describes a callback function

Params:

PropertyTypeDescription
errobjectServer error or null
resobjectExpress response object

Example:

/**

Code:

'callback': setMethodTag,
api

api

GET

Describes an api call

Example:

/**

Code:

'api': setApiTag,
response

response

200

Describes an api response

Example:

/**

Code:

'response': setResponseTag,
Module

Styles

Style tags, can be used to describe your CSS, LESS, Stylus, SCSS or SASS files

Tags

Tags

@var

Describes a variable

Example:

/**

  • Variable title

Code:

'var': setVarTag,

@selector

Describes a css selector

Example:

/**

Code:

'selector': setFunctionTag
mixin

Mixins

fooMixin

Describes a mixin

Example:

/**

  • Mixin title

Code:

'mixin': setFunctionTag,

foo

Describes a parameter for a mixin or a function

Params:

PropertyTypeDescription
colorcolorBackground color

Example:

/**

Code:

'param': addParamTag,
function

Functions

setColor

Describes a function

Example:

/**

  • Function title

Code:

'function': setFunctionTag,