Class: YARD::CLI::Display

Inherits:
Yardoc show all
Defined in:
lib/yard/cli/display.rb

Overview

Display one object

Since:

  • 0.8.6

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ Display

Returns a new instance of Display.

Since:

  • 0.8.6



8
9
10
11
 
# File 'lib/yard/cli/display.rb', line 8

def initialize(*args)
  super
  options.format = :text # default for this command
end

Instance Method Details

#description ⇒ Object

Since:

  • 0.8.6



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

def description; 'Displays a formatted object' end

#parse_arguments(*args) ⇒ Object

Parses commandline options.

Parameters:

Since:

  • 0.8.6



27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/yard/cli/display.rb', line 27

def parse_arguments(*args)
  opts = OptionParser.new
  opts.banner = "Usage: yard display [options] OBJECT [OTHER OBJECTS]"
  general_options(opts)
  output_options(opts)
  parse_options(opts, args)

  Registry.load
  @objects = args.map {|o| Registry.at(o) }

  # validation
  return false if @objects.any? {|o| o.nil? }
  verify_markup_options
end

#run(*args) ⇒ void

This method returns an undefined value.

Runs the commandline utility, parsing arguments and displaying an object from the Registry.

Parameters:

Since:

  • 0.8.6



18
19
20
21
22
23
 
# File 'lib/yard/cli/display.rb', line 18

def run(*args)
  return unless parse_arguments(*args)
  @objects.each do |obj|
    log.puts obj.format(options)
  end
end