Contents

module Useless
  module Doc
    module Core

      # Documentation for an entire API.
      #
      # @!attribute [r] name
      #   @return [String] nameof the API.
      #
      # @!attribute [r] url
      #   @return [String] a the URL of the API.
      #
      # @!attribute [r] description
      #   @return [String] a description of the API.
      #
      # @!attribute [r] timestamp
      #   @return [Time] the time that this API doc was last updated.
      #
      # @!attribute [r] resources
      #   @return [Array<Resource>] the resources included in the API.
      #
      class API

        attr_accessor :name, :url, :description, :timestamp, :resources

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

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
useless-doc-0.5.0	lib/useless/doc/core/api.rb
useless-doc-0.4.0	lib/useless/doc/core/api.rb
useless-doc-0.3.1	lib/useless/doc/core/api.rb
useless-doc-0.3.0	lib/useless/doc/core/api.rb