Class YARD::CLI::YardoptsCommand
In: lib/yard/cli/yardopts_command.rb
Parent: Command

Abstract base class for command that reads .yardopts file

@abstract @since 0.8.3

Methods

new   parse_arguments   yardopts_options  

Constants

DEFAULT_YARDOPTS_FILE = ".yardopts"   The configuration filename to load extra options from

Attributes

options_file  [RW]  The options file name (defaults to {DEFAULT_YARDOPTS_FILE}) @return [String] the filename to load extra options from
use_document_file  [RW]  @return [Boolean] whether to parse options from .document
use_yardopts_file  [RW]  @return [Boolean] whether to parse options from .yardopts

Public Class methods

new()

Creates a new command that reads .yardopts

Public Instance methods

parse_arguments(*args)

Parses commandline arguments @param [Array<String>] args the list of arguments @return [Boolean] whether or not arguments are valid @since 0.5.6

Protected Instance methods

yardopts_options(opts)

Adds —[no-]yardopts / —[no-]document

[Validate]