API changelog

Initial public release of quantum-api.

api

Added

The container for api content. All the entities provided by this module should be used inside an @api entity

api

group

Added

Define a custom group inside an api

changelogList

Added

Define a collection of changelogs for multiple versions.

Behaves differently when using the fileTransform

changelog

Added

Define a changelog for a specific version.

changelogList

Added

Processes and generates changelogs from content in @api sections.

See the Rendering Changelogs example.

description

Added

The description of an entity.

extra

Added

Extra information that should not be part of the description (e.g examples)

collapsed

Added

Whether an api item should be collapsed when loading the page.

collapsible

Added

Whether an api item can be collapsed.

group

Added

Define a custom group inside an api

function

Added

Describes a javascript Function

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@default
@arg
@arg?
@group
@event
@returns

object

Added

Describes a javascript object

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@default
@group
@property
@property?
@event
@prototype
@function

event

Added

Describes a javascript event

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@default

You can also render these as a @function using @event ... [Function] or as an @object using @event ... [Object]. This allows the children of @function and @object to be used as children of this entity.

default

Added

Describes the default value of an optional property or parameter

returns

Added

Describes the return type for a javascript function

The entities that can be used inside an entity of this type are as follows:

@description
@extra

You can also render these as a @function using @returns [Function] or as an @object using @returns [Object]. This allows the children of @function and @object to be used as children of this entity.

param

Added

Describes a function parameter

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@default

You can also render these as a @function using @arg ... [Function] or as an @object using @arg ... [Object]. This allows the children of @function and @object to be used as children of this entity.

param?

Added

Describes an optional function parameter

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@default

property

Added

Describes an object property

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@default

You can also render these in the same way as a @function entity using @property ... [Function], or as an @object using @property ... [Object]. This allows the children of @function and @object to be used as children of this entity.

property?

Added

Describes an optional object property

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@default

prototype

Added

Describes a javscript prototype

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@default
@constructor
@group
@property
@property?
@event
@method
@function

constructor

Added

Describes a constructor for a Prototype.

It is rendered in the same way as a function but does not expect a function name.

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@arg
@arg?

method

Added

Describes a method for a Prototype.

It is rendered in the same way as a function.

The entities that can be used inside an entity of this type are as follows:

@description
@extra
@default
@arg
@arg?
@group
@event
@returns

class

Added

Describes a css class

extraClass

Added

Describes a css class applied to a parent css class

entity

Added

Describes a quantum entity

param

Added

Describes a quantum entity parameter

fileTransformoptionsObjectFileTransform

Added

A wrapper around the exposed file transforms.

fileTransforms

Added

The available file transforms.

entityTransformsoptionsObjectObject[EntityTransform]

Added

A function that returns a set of EntityTransform functions.

languages

Added

The languages available in the quantum-api module.

It is also possible to define Custom Languages

builders

Added

Provides functions for building entity transforms for entities in languages.

See the Custom Language example for a complete example.