Module: ApipieDSL::Common

Included in:
Delegatable::Delegatee
Defined in:
lib/apipie_dsl/dsl.rb

Instance Method Summary collapse

Instance Method Details

#deprecated(value) ⇒ Object 



75
76
77
 
# File 'lib/apipie_dsl/dsl.rb', line 75

def deprecated(value)
  dsl_data[:deprecated] = value
end

#desc(description) ⇒ Object Also known as: description, full_description 



51
52
53
 
# File 'lib/apipie_dsl/dsl.rb', line 51

def desc(description)
  dsl_data[:description] = description
end

#dsl_versions(*versions) ⇒ Object Also known as: dsl_version 



46
47
48
 
# File 'lib/apipie_dsl/dsl.rb', line 46

def dsl_versions(*versions)
  dsl_data[:dsl_versions].concat(versions)
end

#meta(meta) ⇒ Object

Describe additional metadata

meta :author => { :name => 'John', :surname => 'Doe' }



65
66
67
 
# File 'lib/apipie_dsl/dsl.rb', line 65

def meta(meta)
  dsl_data[:meta] = meta
end

#short(short) ⇒ Object Also known as: short_description 



57
58
59
 
# File 'lib/apipie_dsl/dsl.rb', line 57

def short(short)
  dsl_data[:short_description] = short
end

#show(show) ⇒ Object

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



81
82
83
 
# File 'lib/apipie_dsl/dsl.rb', line 81

def show(show)
  dsl_data[:show] = show
end

#tags(*args) ⇒ Object

Add tags to classes and methods group operations together.



70
71
72
73
 
# File 'lib/apipie_dsl/dsl.rb', line 70

def tags(*args)
  tags = args.length == 1 ? args.first : args
  dsl_data[:tag_list] += tags
end