carbond.docgen.APIBPGenerator

extends StaticDocumentationGenerator

Generates api-blueprint style static documentation

Methods

generateBlueprint  
Returns The api-blueprint text for the service
Return type string
Description Generates api-blueprint text
generateDocs  
Arguments
  • docsPath (string) – The path to write docs to
  • options (list) – An array of options as specified by the user
Returns 0 on success, >0 on failure
Return type int
Description Generates api-blueprint docs and writes them to standard out or a file