Method: Useless::Doc::Header#key

Defined in:
lib/useless/doc/header.rb,
lib/useless/doc/header.rb

#key ⇒ String

Returns the key of the header.

Returns:

  • (String) —

    the key of the header.



13
14
15
16
17
18
19
20
21
22
 
# File 'lib/useless/doc/header.rb', line 13

class Header
  attr_accessor :key, :description

  # @param [Hash] attrs corresponds to the class's instance attributes.
  #
  def initialize(attrs = {})
    @key          = attrs[:key]
    @description  = attrs[:description]
  end
end