Class: YARD::CLI::Gems

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

Overview

Since:

  • 0.6.0

Instance Method Summary collapse

Methods inherited from Command

#common_options, #parse_options, run

Constructor Details

#initialize ⇒ Gems

Returns a new instance of Gems.

Since:

  • 0.6.0



5
6
7
8
 
# File 'lib/yard/cli/gems.rb', line 5

def initialize
  @rebuild = false
  @gems = []
end

Instance Method Details

#description ⇒ Object

Since:

  • 0.6.0



10
 
# File 'lib/yard/cli/gems.rb', line 10

def description; "Builds YARD index for gems" end

#run(*args) ⇒ void

This method returns an undefined value.

Runs the commandline utility, parsing arguments and generating YARD indexes for gems.

Parameters:

Since:

  • 0.6.0



17
18
19
20
21
 
# File 'lib/yard/cli/gems.rb', line 17

def run(*args)
  optparse(*args)
  @gems += Gem.source_index.find_name('') if @gems.empty?
  build_gems
end