Class: OSA::DocItem

Inherits:
Object
  • Object
show all
Defined in:
lib/rubyosa/rbosa.rb

Direct Known Subclasses

DocMethod

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, description, optional = false) ⇒ DocItem

Returns a new instance of DocItem.



432
433
434
435
436
 
# File 'lib/rubyosa/rbosa.rb', line 432

def initialize(name, description, optional=false)
  @name = name
  @description = description
  @optional = optional
end

Instance Attribute Details

#description ⇒ Object (readonly)

Returns the value of attribute description.



431
432
433
 
# File 'lib/rubyosa/rbosa.rb', line 431

def description
  @description
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



431
432
433
 
# File 'lib/rubyosa/rbosa.rb', line 431

def name
  @name
end

Instance Method Details

#optional? ⇒ Boolean

Returns:

  • (Boolean) 


437
438
439
 
# File 'lib/rubyosa/rbosa.rb', line 437

def optional?
  @optional
end