Class: Generator

Defined in: src/generator.coffee

Overview

The documentation generator uses the parser JSON

Instance Method Summary

Constructor Details

.constructor(parser, options) Source

Construct a generator

Parameters:

  • parserThe parser (a [Parser])
  • optionsThe options (a [Object])

Instance Method Details

.copy(from, to) Source

Copy a file

Parameters:

  • fromthe source file name (a [String])
  • tothe destination file name (a [String])

.copyAssets() Source

Copy the styles and scripts.

.generate(file) Source

Generate the documentation. Without callback, the documentation

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

Parameters:

  • fileTtheoptional file generation callback (a [Function])

.generateClassAndMixinLists() Source

Generates the drop down class list

.generateClassMixinFileExtraIndex() Source

Generate the alphabetical index of all classes and mixins.

.generateClasses() Source

Generates the pages for all the classes.

.generateExtraList() Source

Generates the drop down extra list

.generateExtras() Source

.generateFileList() Source

Generates the drop down file list

.generateFiles() Source

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

.generateIndex() Source

Generate the frame source.

.generateMethodList() Source

Generates the drop down method list

.generateMixins() Source

Generate the pages for all the mixins

.generateSearchData(file) Source

Write the data used in search into

Parameters:

  • filethe file callback (a [Function])