Class: TomDoc::Arg

Inherits:

Object

• Object
• TomDoc::Arg

Defined in:

lib/tomdoc/arg.rb

Instance Attribute Summary

• #description ⇒ Object

  Returns the value of attribute description.

• #name ⇒ Object

  Returns the value of attribute name.

Instance Method Summary

• #initialize(name, description = '') ⇒ Arg constructor

  A new instance of Arg.

• #optional? ⇒ Boolean

Constructor Details

#initialize(name, description = '') ⇒ Arg

Returns a new instance of Arg.

# File 'lib/tomdoc/arg.rb', line 5

def initialize(name, description = '')
  @name = name.to_s.intern
  @description = description
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.

# File 'lib/tomdoc/arg.rb', line 3

def description
  @description
end

#name ⇒ Object

Returns the value of attribute name.

# File 'lib/tomdoc/arg.rb', line 3

def name
  @name
end

Instance Method Details

#optional? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/tomdoc/arg.rb', line 10

def optional?
  @description.downcase.include? 'optional'
end