Module: Raml::Documentable

Included in:

AbstractMethod, AbstractResource, Parameter::AbstractParameter, Response

Defined in:

lib/raml/mixin/documentable.rb

Instance Attribute Summary

• #description ⇒ String^?

  The node’s description.

• #display_name ⇒ String^?

  The node’s display name.

Instance Method Summary

• #html_description ⇒ Object

Instance Attribute Details

#description ⇒ String^?

Returns the node’s description.

Returns:

• (String, nil) —

  the node’s description.

# File 'lib/raml/mixin/documentable.rb', line 8

#display_name ⇒ String^?

Returns the node’s display name.

Returns:

• (String, nil) —

  the node’s display name.

# File 'lib/raml/mixin/documentable.rb', line 5

Instance Method Details

#html_description ⇒ Object

# File 'lib/raml/mixin/documentable.rb', line 12

def html_description
  Kramdown::Document.new(description, input: :GFM).to_html
end