Class: YARD::CLI::Gems

Inherits:

Command

• Object
• Command
• YARD::CLI::Gems

Defined in:

lib/yard/cli/gems.rb

Overview

Since:

• 0.6.0

Instance Method Summary

• #description ⇒ Object
• #initialize ⇒ Gems constructor

  A new instance of Gems.

• #run(*args) ⇒ void

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

Methods inherited from Command

#common_options, #load_script, #parse_options, run

Constructor Details

#initialize ⇒ Gems

Returns a new instance of Gems.

Since:

• 0.6.0

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

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

Instance Method Details

#description ⇒ Object

Since:

• 0.6.0

# 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:

• args (Array<String>) —

  the list of arguments

Since:

• 0.6.0

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

def run(*args)
  require 'rubygems'
  optparse(*args)
  build_gems
end