Fireball Engine API

Fireball is the game engine for the future.

AST Class

Defined in: lib/ast.js:163
Module: firedoc

The AST(Abstract syntax tree) of the comment

Index

Show:

Properties

Methods

Properties

project Object

Defined in lib/ast.js:170

About the project

files Object

Defined in lib/ast.js:175

The files

codes Object

Defined in lib/ast.js:180

The source codes

modules Object

Defined in lib/ast.js:185

The modules

classes Object

Defined in lib/ast.js:190

The classes

members Array

Defined in lib/ast.js:195

The members

inheritedMembers Array

Defined in lib/ast.js:200

The inherited members

commentsMap Object

Defined in lib/ast.js:205

The comments map object

syntaxType String

Defined in lib/ast.js:210

The syntax type

context Context

Defined in lib/ast.js:215

The context object

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

create
(
  • files
  • dirs
  • [syntaxType]
)
AST

Defined in lib/ast.js:225

Create a AST object

parameters:

  • files Object
    The files
  • dirs Object
    The directorys
  • syntaxType String
    The syntax type: coffee or js

returns:

type: AST

the created AST object

reset ()

Defined in lib/ast.js:244

Reset the AST instance

oncomment
(
  • comment
  • filename
  • linenum
)
Object

Defined in lib/ast.js:267

parameters:

  • comment String
  • filename String
  • linenum String

returns:

type: Object

onblock
(
  • an
)

Defined in lib/ast.js:337

Processes all the tags in a single comment block

parameters:

  • an Array
    array of the tag/text pairs

ontag
(
  • item
)

Defined in lib/ast.js:369

Process tag

parameters:

  • item Object
    • tag String
    • value Object

extract
(
  • files
  • dirs
)

Defined in lib/ast.js:416

Accepts a map of filenames to file content. Returns a map of filenames to an array of API comment block text. This expects the comment to start with / * on its own line, and end with / on its own line. Override this function to provide an alternative comment parser.

parameters:

  • files Object
  • dirs Object

transform
(
  • commentmap
)
Object

Defined in lib/ast.js:456

Transforms a map of filenames to arrays of comment blocks into a JSON structure that represents the entire processed API doc info and relationships between elements for the entire project.

parameters:

  • commentmap Object
    The hash of files and parsed comment blocks

returns:

type: Object

The transformed data for the project

resolveFor
(
  • value
)
String private

Defined in lib/ast.js:472

Takes a non-namespaced classname and resolves it to a namespace (to support @for)

parameters:

  • value String
    The classname to resolve

returns:

type: String

The resolved namespace + classname

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