class Autodoc::Document::Parameter
Attributes
Public Class Methods
Source
# File lib/autodoc/document.rb, line 230 def initialize(validator) @validator = validator end
Public Instance Methods
Source
# File lib/autodoc/document.rb, line 234 def to_s string = "#{body}#{payload}" if validator.respond_to? :validators validator.validators.each do |x| string += "\n#{Parameter.new(x).to_s.indent(2)}" end end string end
Private Instance Methods
Source
# File lib/autodoc/document.rb, line 262 def assets @assets ||= [required, only, except].compact end
Source
# File lib/autodoc/document.rb, line 248 def body if validator.key.nil? "* #{validator.type}" else "* `#{validator.key}` #{validator.type}" end end
Source
# File lib/autodoc/document.rb, line 274 def except "except: `#{validator.options[:except].inspect}`" if validator.options[:except] end
Source
# File lib/autodoc/document.rb, line 270 def only "only: `#{validator.options[:only].inspect}`" if validator.options[:only] end
Source
# File lib/autodoc/document.rb, line 256 def payload string = assets.any? ? " (#{assets.join(', ')})" : "" string += " - #{validator.options[:description]}" if validator.options[:description] string end
Source
# File lib/autodoc/document.rb, line 266 def required "required" if validator.required? end