Skip to content

Latest commit

 

History

History
374 lines (217 loc) · 11.9 KB

Locals.md

File metadata and controls

374 lines (217 loc) · 11.9 KB

firedoc 1.9.2

Fireball is the game engine for the future.

Locals Class

Defined in: lib/locals.js:14

Module: digesters Parent Module: firedoc

The Theme Locals

Index

Properties
  • context BuilderContext Builder Context
  • options Option The options
  • ast AST The AST object
  • project Object Get the project to export
  • i18n Object Get i18n object
  • modules Object Get modules object to export
  • classes Object Get classes object to export
  • files Object Get files object to export
  • _mergeCounter Number Counter for stepping into merges
Methods

Details

Properties

context

Builder Context

meta description
Type BuilderContext
Defined lib/locals.js:20
options

The options

meta description
Type Option
Defined lib/locals.js:25
ast

The AST object

meta description
Type AST
Defined lib/locals.js:30
project

Get the project to export

meta description
Type Object
Defined lib/locals.js:35
i18n

Get i18n object

meta description
Type Object
Defined lib/locals.js:52
modules

Get modules object to export

meta description
Type Object
Defined lib/locals.js:70
classes

Get classes object to export

meta description
Type Object
Defined lib/locals.js:89
files

Get files object to export

meta description
Type Object
Defined lib/locals.js:113
_mergeCounter

Counter for stepping into merges

meta description
Type Number
Defined lib/locals.js:440

Methods

initMarkdownRulers

Initialize the markdownit rulers

meta description
Defined lib/locals.js:127
addFoundAt

Parses file and line number from an item object and build's an HREF

meta description
Defined lib/locals.js:155
Return String
Parameters
getMethodName

build the method name by its name and parameters

meta description
Defined lib/locals.js:173
Parameters
  • name String The function/method name
  • params Array The function/method parameters list
    • name String The name of the parameter
_parseCode

Parses <pre class="code prettyprint"><code> tags and adds the prettyprint className to them

meta description
Defined lib/locals.js:187
Return HTML
Parameters
  • html HTML The HTML to parse
markdown

Wrapper around the Markdown parser so it can be normalized or even side stepped

meta description
Defined lib/locals.js:202
Return HTML
Parameters
  • data String The Markdown string to parse
appendClassToModule

append the clazz to its module

meta description
Defined lib/locals.js:232
Parameters
  • clazz Object The class object
    • module String The module name of this clazz object
getClassInheritanceTree

get class inheritance tree

meta description
Defined lib/locals.js:248
Return Object
buildMember

build the member

meta description
Defined lib/locals.js:288
Return Object
Parameters
  • memeber Object The member object
  • forceBeMethod Boolean force make the build process be for method
  • parent Object The parent context
buildMembers

build the members

meta description
Defined lib/locals.js:353
Return Boolean
augmentData

Augments the DocParser meta data to provide default values for certain keys as well as parses all descriptions with the Markdown Parser

meta description
Defined lib/locals.js:380
Return Object
Parameters
  • o Object The object to recurse and augment
mergeExtends

Merge superclass data into a child class

meta description
Defined lib/locals.js:448
Parameters
  • info Object The item to extend
  • members Array The list of items to merge in
  • first Boolean Set for the first call
getExpandIterator

generate expand function

meta description
Defined lib/locals.js:501
Parameters
  • parent Object The object to be set
extendMembers

extends members array

meta description
Defined lib/locals.js:526
Parameters
expandMembersFromModules

extends modules

meta description
Defined lib/locals.js:546
Parameters
expandMembersFromModules

extends members from classes

meta description
Defined lib/locals.js:568
Parameters
create

Create a locals object from context

meta description
Defined lib/locals.js:590
Parameters