class Apipie::SeeDescription
Attributes
description[R]
link[R]
Public Class Methods
new(args)
click to toggle source
# File lib/apipie/see_description.rb, line 7 def initialize(args) if args.first.is_a? Hash args = args.first elsif args.count == 2 if args.last.is_a? Hash args = {:link => args.first}.merge(args.last) else args = {:link => args.first, :description => args.second} end elsif args.count == 1 && args.first.is_a?(String) args = {:link => args.first, :description => args.first} else raise ArgumentError "ApipieError: Bad use of see method." end @link = args[:link] || args['link'] @description = args[:desc] || args[:description] || args['desc'] || args['description'] end
Public Instance Methods
see_url()
click to toggle source
# File lib/apipie/see_description.rb, line 29 def see_url method_description = Apipie[@link] if method_description.nil? raise ArgumentError.new("Method #{@link} referenced in 'see' does not exist.") end method_description.doc_url end
to_json()
click to toggle source
# File lib/apipie/see_description.rb, line 25 def to_json {:link => see_url, :description => description} end