class YARD::CLI::List

Lists all constant and method names in the codebase. Uses {Yardoc} –list.

Public Instance Methods

description() click to toggle source
# File lib/yard/cli/list.rb, line 6
def description; 'Lists all constant and methods. Uses `yard doc --list`' end
run(*args) click to toggle source

Runs the commandline utility, parsing arguments and displaying a list of objects

@param [Array<String>] args the list of arguments. @return [void]

# File lib/yard/cli/list.rb, line 13
def run(*args)
  if args.include?('--help')
    log.puts "Usage: yard list [yardoc_options]"
    log.puts "Takes the same arguments as yardoc. See yardoc --help"
  else
    Yardoc.run('-c', '--list', *args)
  end
end