123456789_123456789_123456789_123456789_123456789_

Class: YARD::CLI::List

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Command
Instance Chain:
self, Command
Inherits: YARD::CLI::Command
Defined in: lib/yard/cli/list.rb

Overview

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

Class Method Summary

Command - Inherited

.run

Helper method to run the utility on an instance.

Instance Method Summary

Command - Inherited

#description

Instance Method Details

#description

[ GitHub ] 

  


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



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:





  [ GitHub ]


  

  


# 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