Fireball Engine API

Fireball is the game engine for the future.

DocParser Class

Module: firedoc

Index

Show:

Properties

Methods

Properties

IGNORE_TAGLIST Array

Defined in lib/ast.js:30

A list of ignored tags. These tags should be ignored because there is likely to be used for purposes other than JSDoc tags in JavaScript comments.

CORRECTIONS Object

Defined in lib/ast.js:40

Common errors will get scrubbed instead of being ignored.

TAGLIST Array

Defined in lib/ast.js:77

A list of known tags. This populates a member variable during initialization, and will be updated if additional digesters are added.

DIGESTERS Object

Defined in lib/ast.js:492

A map of the default tag processors, keyed by the tag name. Multiple tags can use the same digester by supplying the string name that points to the implementation rather than a function.

There are no properties that match your current filter settings. You can change your filter settings in the index section on this page. index

Methods

implodeString
(
  • str
)
String private

Defined in lib/ast.js:1103

Flatten a string, remove all line breaks and replace them with a token

parameters:

  • str String
    The string to operate on

returns:

type: String

The modified string

implodeString
(
  • str
)
String private

Defined in lib/ast.js:1114

Un-flatten a string, replace tokens injected with implodeString

parameters:

  • str String
    The string to operate on

returns:

type: String

The modified string

There are no methods that match your current filter settings. You can change your filter settings in the index section on this page. index