v0.5.0
Module

Generic

Generic tags, these tags are available in all languages

Tags

Tags

@version

Define a package or module version

@package

Creates a package and groups all folowing anotations to this package

A package can contain a set of subpackages and modules

v0.4.7

@subpackage

Creates a subpackage and groups all folowing anotations to this subpackage

A subpackage can contain a set of modules

Example:

/**
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:

/**
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:

/**

myname

Defines a name for a block

Example:

/**

@public

Public

Sets the public flag for a block

Example:

/**

@protected

Protected

Sets the protected flag for a block

Example:

/**

@private

Private

Sets the private flag for a block

Example:

/**

@unimplemented

Unimplemented

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

Example:

/**

@beta

Beta

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

Example:

/**

@new

New

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

Example:

/**

@deprecated

Deprecated

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

Example:

/**

@example

Defines an example block.

Example:

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

@preview

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

Preview:

#ff0000 lt;/div>

@type

Defines a type for a block

Example:

/**

Example:

/**
mygroup

mygroup

@group

Creates a new group and passes block to these group

Example:

/**
Module

Javascript

Javascript specific tags

method

Methods

foo

Descripes function or method params

Params:

PropertyTypeDescription
objobjectFoo object
silentboolOptional silent property

Example:

/**

foo

Describes a method

Example:

class MyClass { /**

* Method foo

foo

Describes a return value of a method or function

Returns:

object
Returns a promise

Example:

/**
property

Properties

obj

object

Descripes a property

Example:

/**

  • My property
Tags

Tags

@function

TODO

Example:

/* *\/

@return

See returns tag

@default

TODO

Example:

/* *\/

@event

Describes an event that can be triggered

Example:

/* *\/

@fires

Describes events that a function or method triggers

Example:

/**

@arg

Describes the arguments for a event call

Fires:

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

Example:

/**

@async

Async

Marks a block as asyncron

Example:

/**

@chainable

Chainable

Marks a block as chainable

Example:

/**

@arg

Describes the arguments for a event call

Fires:

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

Example:

/**

@header

Describes an api header

Example:

/**

@cookie

Describes an api cookie

Example:

/**
mixin

Mixins

requestLogger

Describes a mixin

Params:

PropertyTypeDescription
reqobjectExpress req object
resobjectExpress res object
nextfunctionNext callback

Example:

/**

  • Loggs api requests

requestLogger

Describes a middleware function

Params:

PropertyTypeDescription
reqobjectExpress req object
resobjectExpress res object
nextfunctionNext callback

Example:

/**

  • Loggs api requests
class

Classes

MyClass

Describes a class

Example:

/**

  • My fancy class
const

Constants

SERVER

string

Describes a constant

Example:

/**

  • Constant title
var

Variables

isFoo

boolean

Describes a variable

Example:

/**

  • Variable title
constructor

Constructors

ction MyCalss() { / some code

Describes a class constructor

Example:

/**

  • Class constructor
returnValue

returnValue

promise

Detailed description of a return value

Example:

/**

promise

Describes an error argument for an event or function call

Example:

/**
callback

Callbacks

done

Describes a callback function

Params:

PropertyTypeDescription
errobjectServer error or null
resobjectExpress response object

Example:

/**
api

api

GET

Describes an api call

Example:

/**
response

response

200

Describes an api response

Example:

/**
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

@selector

Describes a css selector

Example:

/**
mixin

Mixins

fooMixin

Describes a mixin

Example:

/**

  • Mixin title

foo

Describes a parameter for a mixin or a function

Params:

PropertyTypeDescription
colorcolorBackground color

Example:

/**
function

Functions

setColor

Describes a function

Example:

/**

  • Function title