Sha256: 20a123356ce83bbec694467e77ba666f09cd69744ff58cd8d016c8a340c82ec6

Contents?: true

Size: 758 Bytes

Versions: 28

Compression:

Stored size: 758 Bytes

Contents

module PDoc
  module Models
    class Argument < Base
      attr_reader :name
      attr_reader :default_value
      
      def attach_to_parent(parent)
        parent.arguments << self
      end
      
      # returns the argument's id in the form
      # method_id:argument_name. So, for example:
      # document.querySelectorAll:cssSelector
      def id
        @id ||= "#{parent.id}:#{name}"
      end
      
      def optional?
        !!@optional
      end
      
      def types
        @types ||= []
      end
      
      def to_hash
        {
          :name => name,
          :description => description,
          :default_value => default_value,
          :optional => optional?,
          :types => types
        }
      end
    end
  end
end

Version data entries

28 entries across 28 versions & 2 rubygems

Version Path
distil-0.14.4 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.3 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.2 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.2.a vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.1 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.1.a vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.0 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.0.i vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.0.h vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.0.g vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.0.d vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.0.c vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.14.0.b vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.13.6 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.13.5 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.13.4 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.13.3 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.13.2 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.13.1 vendor/pdoc/lib/pdoc/models/argument.rb
distil-0.13.0 vendor/pdoc/lib/pdoc/models/argument.rb