Method: YARD::Serializers::FileSystemSerializer#initialize

Defined in:
lib/yard/serializers/file_system_serializer.rb

#initialize(opts = {}) ⇒ FileSystemSerializer

Creates a new FileSystemSerializer with options

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :basepath (String) — default: 'doc' —

    the base path to write data to

  • :extension (String) — default: 'html' —

    the extension of the serialized path filename. If this is set to the empty string, no extension is used.



28
29
30
31
32
33
 
# File 'lib/yard/serializers/file_system_serializer.rb', line 28

def initialize(opts = {})
  super
  @name_map = nil
  @basepath = (options[:basepath] || 'doc').to_s
  @extension = (options.key?(:extension) ? options[:extension] : 'html').to_s
end