Class: Generator

Defined in: src/generator.coffee

Overview

The documentation generator uses the intermediate JSON from Parser,

Instance Method Summary

Constructor Details

.constructor(parser, options)

Constructs a generator

Parameters:

  • (Parser) parserA Parser object
  • (Object) optionsAn {Object} of options

Instance Method Details

.copy(from, to)

Copy a file from its temporary location to a more permanent one.

Parameters:

  • (String) fromThe source filename as a {String}
  • (String) toThe destination filename as a {String}

.copyAssets()

Copy the styles and scripts.

.generate(file = null)

Generate the documentation. Without the file callback, the documentation

With a provided file generation callback, the assets will not be copied. You can use Biscotto@script and Biscotto@style to get them.

Parameters:

  • (Function) fileA {Function} that acts as a file generation callback

.generateClassAndMixinLists()

Generates the drop down class list

.generateClassMixinFileExtraIndex()

Generate the alphabetical index of all classes and mixins.

.generateClasses()

Generates the pages for all the classes.

.generateExtraList()

Generates the drop down extra list.

.generateExtras()

Generates the pages for all the extra files.

.generateFileList()

Generates the drop down file list.

.generateFiles()

Generate the pages for all the (non-class) files that contains methods.

.generateIndex()

Generates the frame source.

.generateMethodList()

Generates the drop down method list.

.generateMixins()

Generate the pages for all the mixins.

.generateSearchData(file)

Writs the data used by search into a JSON file used by the frontend.

Parameters:

  • (Function) fileA {Function} callback after every file is read