Class: YARD::CLI::List

Inherits:
Command show all
Defined in:
lib/yard/cli/list.rb

Overview

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

Instance Method Summary collapse

Methods inherited from Command

#common_options, #load_script, #parse_options, run

Instance Method Details

#description ⇒ Object 



5
 
# File 'lib/yard/cli/list.rb', line 5

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

#run(*args) ⇒ void

This method returns an undefined value.

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

Parameters:



12
13
14
15
16
17
18
19
 
# File 'lib/yard/cli/list.rb', line 12

def run(*args)
  if args.include?('--help')
    puts "Usage: yard list [yardoc_options]"
    puts "Takes the same arguments as yardoc. See yardoc --help"
  else
    Yardoc.run('--list', *args)
  end
end