Contents

module Useless
  module Doc
    module Core

      # Documentation for a domain - a group of APIs.
      #
      # @!attribute [r] name
      #   @return [String] a name of the domain.
      #
      # @!attribute [r] url
      #   @return [String] a the URL of the domain.
      #
      # @!attribute [r] description
      #   @return [String] a description of the domain.
      #
      # @!attribute [r] apis
      #   @return [Array<API>] the APIs included in this domain.
      #
      class Domain

        attr_accessor :name, :url, :description, :apis

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

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
useless-doc-0.3.1	lib/useless/doc/core/domain.rb
useless-doc-0.3.0	lib/useless/doc/core/domain.rb