Module: Ronin::Core::Metadata::Description

Defined in:
lib/ronin/core/metadata/description.rb

Overview

Adds a description metadata attribute to a class.

Example

class MyModule

  include Ronin::Core::Metadata::Description

  description <<~DESC
    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
    eiusmod tempor incididunt ut labore et dolore magna aliqua.

    Ut enim ad minim veniam, quis nostrud exercitation ullamco
    laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure
    dolor in reprehenderit in voluptate velit esse cillum dolore eu

    fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
    proident, sunt in culpa qui officia deserunt mollit anim id est
    laborum.
  DESC

end

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Class Method Details

.included(base) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Adds ClassMethods to the class.

Parameters:



56
57
58
 
# File 'lib/ronin/core/metadata/description.rb', line 56

def self.included(base)
  base.extend ClassMethods
end