Contents

module Useless
  module Doc

    # Documentation for an HTTP header, belonging either to the request or the
    # response.
    #
    # @!attribute [r] key
    #   @return [String] the key of the header.
    #
    # @!attribute [r] description
    #   @return [String] a description of the header.
    #
    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
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
useless-doc-0.1.3	lib/useless/doc/header.rb
useless-doc-0.1.2	lib/useless/doc/header.rb
useless-doc-0.1.1	lib/useless/doc/header.rb
useless-doc-0.1.0	lib/useless/doc/header.rb