Class: Generator
Defined in: | src/generator.coffee |
Overview
The documentation generator uses the intermediate JSON from Parser, and generates the final HTML Biscotto documentation.
Instance Method Summary
- ::constructor(parser, options) Constructor Constructs a generator
- ::copy(from, to) Copy a file from its temporary location to a more permanent one.
- ::copyAssets() Copy the styles and scripts.
- ::generate(file = null) Generate the documentation.
- ::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.
Constructor Details
::constructor(parser, options) Source
Constructs a generator
Instance Method Details
::copy(from, to) Source
Copy a file from its temporary location to a more permanent one.
::copyAssets() Source
Copy the styles and scripts.
::generate(file = null) Source
Generate the documentation. Without the file
callback, the documentation is written to the file system. With the callback, the file's contents is passed to the callback.
With a provided file generation callback, the assets will not be copied. You can use Biscotto.script and Biscotto.style to get them.
::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
Generates the pages for all the extra files.
::generateFileList() Source
Generates the drop down file list.
::generateFiles() Source
Generate the pages for all the (non-class) files that contains methods.
::generateIndex() Source
Generates the frame source.
::generateMethodList() Source
Generates the drop down method list.
::generateMixins() Source
Generate the pages for all the mixins.
::generateSearchData(file) Source
Writs the data used by search into a JSON file used by the frontend.