Class: Biscotto

Defined in: src/biscotto.coffee

Overview

Biscotto - the TomDoc-CoffeeScript API documentation generator

Class Method Summary

Class Method Details

@detectExtras(done) Source

Find extra project files.

@detectName(done) Source

Find the project name by either parse package.json

Parameters:

  • doneThe callback to call

@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:

Parameters:

  • doneThe documentation done callback (a [Function])
  • fileThe new file callback (a [Function])
  • analyticsThe Google analytics tracking code (a [String])
  • homepageThe homepage in the breadcrumbs (a [String])

@script() Source

Get the Biscotto script content that is used in the webinterface

Returns:

  • Returns the script content (a [String])

@style() Source

Get the Biscotto style content that is used in the webinterface

Returns:

  • Returns the style content (a [String])

@version() Source

Get the current Biscotto version

Returns:

  • Returns a [String] representing the Biscotto version