Class: Angus::SDoc::Definitions::UriElement

Inherits:

Object

• Object
• Angus::SDoc::Definitions::UriElement

Defined in:

lib/angus/definitions/uri_element.rb

Instance Attribute Summary

• #description ⇒ String

  The description of the uri element.

• #name ⇒ String

  The name of the uri element.

Instance Method Summary

• #initialize(name = nil, description = nil) ⇒ UriElement constructor

  A new instance of UriElement.

Constructor Details

#initialize(name = nil, description = nil) ⇒ UriElement

Returns a new instance of UriElement.

# File 'lib/angus/definitions/uri_element.rb', line 13

def initialize(name = nil, description = nil)
  @name = name
  @description = description
end

Instance Attribute Details

#description ⇒ String

Returns the description of the uri element.

Returns:

• (String) —

  the description of the uri element.

# File 'lib/angus/definitions/uri_element.rb', line 11

def description
  @description
end

#name ⇒ String

Returns the name of the uri element.

Returns:

• (String) —

  the name of the uri element.

# File 'lib/angus/definitions/uri_element.rb', line 7

def name
  @name
end