class YARD::CLI::List

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

def description; 'Lists all constant and methods. Uses `yard doc --list`' end

def description; 'Lists all constant and methods. Uses `yard doc --list`' end

def run(*args)

Returns:
  • (void) -

Parameters:
  • args (Array) -- the list of arguments.
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