class Autodoc::Document::Parameter
Attributes
validator[R]
Public Class Methods
new(validator)
click to toggle source
# File lib/autodoc/document.rb, line 228 def initialize(validator) @validator = validator end
Public Instance Methods
to_s()
click to toggle source
# File lib/autodoc/document.rb, line 232 def to_s string = "" string << "#{body}#{payload}" if validator.respond_to? :validators validator.validators.each do |x| string << "\n" string << Parameter.new(x).to_s.indent(2) end end string end
Private Instance Methods
assets()
click to toggle source
# File lib/autodoc/document.rb, line 263 def assets @assets ||= [required, only, except].compact end
body()
click to toggle source
# File lib/autodoc/document.rb, line 248 def body if validator.key.nil? "* #{validator.type}" else "* `#{validator.key}` #{validator.type}" end end
except()
click to toggle source
# File lib/autodoc/document.rb, line 275 def except "except: `#{validator.options[:except].inspect}`" if validator.options[:except] end
only()
click to toggle source
# File lib/autodoc/document.rb, line 271 def only "only: `#{validator.options[:only].inspect}`" if validator.options[:only] end
payload()
click to toggle source
# File lib/autodoc/document.rb, line 256 def payload string = "" string << " (#{assets.join(', ')})" if assets.any? string << " - #{validator.options[:description]}" if validator.options[:description] string end
required()
click to toggle source
# File lib/autodoc/document.rb, line 267 def required "required" if validator.required? end