Class: Raml::Documentation

Inherits:

PropertiesNode

• Object
• Node
• PropertiesNode
• Raml::Documentation

Defined in:

lib/raml/node/documentation.rb

Instance Attribute Summary

• #content ⇒ String

  The documentation content.

• #title ⇒ String

  The documentation title.

Attributes inherited from PropertiesNode

#optional

Attributes inherited from Node

#name, #parent

Method Summary

Methods inherited from PropertiesNode

#_regexp_property, #initialize, #non_scalar_properties, #scalar_properties

Methods inherited from Node

#initialize

Constructor Details

This class inherits a constructor from Raml::PropertiesNode

Instance Attribute Details

#content ⇒ String

Returns the documentation content.

Returns:

• (String) —

  the documentation content.

# File 'lib/raml/node/documentation.rb', line 4

#title=(value) ⇒ String

Returns the documentation title. An alias for #name.

Returns:

• (String) —

  the documentation title. An alias for #name.

# File 'lib/raml/node/documentation.rb', line 10

scalar_property :content