YUIDoc

YUIDoc generates API documentation from comments in JavaScript code.

YAML Configuration

yuidoc:

  • config-file:

    • Path to the YUIDoc configuration file (yuidoc.json).
    • If this field is omitted, Docstand lets YUIDoc to search for yuidoc.json under the repository. If yuidoc.json has been found, YUIDoc uses it.
  • input-dirs:

    • If this field is omitted:
      • In case when the YUIDoc configuration file is present, YUIDoc refers to it.
      • Otherwise, Docstand sets the input path to src.
  • machine:

    • cpu:

      Amount of CPU. The default machine has 0.5 CPU with 1920 MiB RAM.

  • options:

    Below is the list of supported options:

     -e, --extension <comma sep list of file extensions> The list of file extensions to parse
           for api documentation. (defaults to .js)
     -x, --exclude <comma sep list of directories> Directories to exclude from parsing
           (defaults to '.DS_Store,.svn,CVS,.git,build_rollup_tmp,build_tmp')
     --project-version Set the doc version for the template
     --no-sort Do not alphabetical sorting of attributes, events, methods, and properties
     -S, --selleck Look for Selleck component data and attach to API meta data
     -t, --themedir <directory path> Path to a custom theme directory containing Handlebars templates
     -H, --helpers <comma separated list of paths to files> Require these file and add Handlebars helpers. See docs for more information
     --charset CHARSET Use this as the default charset for all file operations. Defaults to 'utf8'
     -T, --theme <simple|default> Choose one of the built in themes (default is default)
     --syntaxtype <js|coffee> Choose comment syntax type (default is js)
    

Examples

  • With yuidoc set to default

    docstand:
      yuidoc: default
    
  • With custom machine:

    docstand:
      yuidoc:
        machine:
          cpu: 1.5 # 1.5 CPU, 5760 MiB RAM
    
  • With input-dirs option

    docstand:
      yuidoc:
        input-dirs: lib
    
  • With config-file option

    docstand:
      yuidoc:
        config-file: src/api/yuidoc.json
    
  • In the case of CoffeeScript

    docstand:
      yuidoc:
        options:
           --extension: .coffee
           --syntaxtype: coffee
    

    Note: YUIDoc also supports CoffeeScript comment syntax. See CoffeeScript comment sample for YUIDoc.

results matching ""

    No results matching ""