module ApipieDSL::Common

Public Instance Methods

deprecated(value) click to toggle source
# File lib/apipie_dsl/dsl.rb, line 74
def deprecated(value)
  dsl_data[:deprecated] = value
end
desc(description) click to toggle source
# File lib/apipie_dsl/dsl.rb, line 50
def desc(description)
  dsl_data[:description] = description
end
Also aliased as: description, full_description
description(description)
Alias for: desc
dsl_version(*versions)
Alias for: dsl_versions
dsl_versions(*versions) click to toggle source
# File lib/apipie_dsl/dsl.rb, line 45
def dsl_versions(*versions)
  dsl_data[:dsl_versions].concat(versions)
end
Also aliased as: dsl_version
full_description(description)
Alias for: desc
meta(meta) click to toggle source

Describe additional metadata

meta :author => { :name => 'John', :surname => 'Doe' }
# File lib/apipie_dsl/dsl.rb, line 64
def meta(meta)
  dsl_data[:meta] = meta
end
short(short) click to toggle source
# File lib/apipie_dsl/dsl.rb, line 56
def short(short)
  dsl_data[:short_description] = short
end
Also aliased as: short_description
short_description(short)
Alias for: short
show(show) click to toggle source

Determine if the method (class) should be included in the documentation

# File lib/apipie_dsl/dsl.rb, line 80
def show(show)
  dsl_data[:show] = show
end
tags(*args) click to toggle source

Add tags to classes and methods group operations together.

# File lib/apipie_dsl/dsl.rb, line 69
def tags(*args)
  tags = args.length == 1 ? args.first : args
  dsl_data[:tag_list] += tags
end