Class YARD::Formatter

Object
  |
  +--YARD::Formatter

Formats the code objects in the Namespace in a variety of formats

Author:
Loren Segal

Constants

OUTPUT_FORMATS = [ :html, :xhtml, :xml ]

Public Instance Method Summary

Object format(object, format = :html)
      Formats an object as a specified output format .
Object template_directory
      Directory for templates .

Public Instance Method Details

format

public Object format(object, format = :html)

Formats an object as a specified output format. Default is +:html+.

Parameters:
[String, CodeObject] object - the code object to format or the path to the code object
[Symbol] format - the output format to generate documentation in. Defaults to +:html+, which is a synonym for +:xhtml+.
See Also:
OUTPUT_FORMATS

template_directory

public Object template_directory

Directory for templates. Override this to load your own templates