module ApipieDSL::Common
Public Instance Methods
deprecated(value)
click to toggle source
# File lib/apipie_dsl/dsl.rb, line 75 def deprecated(value) dsl_data[:deprecated] = value end
desc(description)
click to toggle source
# File lib/apipie_dsl/dsl.rb, line 51 def desc(description) dsl_data[:description] = description end
Also aliased as: description, full_description
dsl_versions(*versions)
click to toggle source
# File lib/apipie_dsl/dsl.rb, line 46 def dsl_versions(*versions) dsl_data[:dsl_versions].concat(versions) end
Also aliased as: dsl_version
meta(meta)
click to toggle source
Describe additional metadata
meta :author => { :name => 'John', :surname => 'Doe' }
# File lib/apipie_dsl/dsl.rb, line 65 def meta(meta) dsl_data[:meta] = meta end
short(short)
click to toggle source
# File lib/apipie_dsl/dsl.rb, line 57 def short(short) dsl_data[:short_description] = short end
Also aliased as: short_description
show(show)
click to toggle source
Determine if the method (class) should be included in the documentation
# File lib/apipie_dsl/dsl.rb, line 81 def show(show) dsl_data[:show] = show end