Class: Biscotto
Defined in: | src/biscotto.coffee |
Overview
Biscotto - the TomDoc-CoffeeScript API documentation generator
Class Method Summary
- @detectExtras(done) Find extra project files.
-
@detectName(done)
Find the project name by either parse
package.json
- @detectReadme(done) Find the project README.
- @detectSources(done) Find the source directories.
- @run(done, file, analytics = false, homepage = false) Run the documentation generator.
- @script() Get the Biscotto script content that is used in the webinterface
- @style() Get the Biscotto style content that is used in the webinterface
- @version() Get the current Biscotto version
Class Method Details
@detectExtras(done) Source
Find extra project files.
@detectName(done) Source
Find the project name by either parse package.json
@detectReadme(done) Source
Find the project README.
@detectSources(done) Source
Find the source directories.
@run(done, file, analytics = false, homepage = false) Source
Run the documentation generator. This is usually done through
You can also run the documentation generation without writing files to the file system, by supplying a callback function.
Examples:
@script() Source
Get the Biscotto script content that is used in the webinterface
@style() Source
Get the Biscotto style content that is used in the webinterface
@version() Source
Get the current Biscotto version