Contents

# Define custom tags
YARD::Tags::Library.define_tag("URL for the Resource",          :resource)
YARD::Tags::Library.define_tag("HTTP-Action for the Resource",  :action)

YARD::Tags::Library.define_tag("Required Arguments",            :required,          :with_types_and_name)
YARD::Tags::Library.define_tag("Optional Arguments",            :optional,          :with_types_and_name)

YARD::Tags::Library.define_tag("Example Request",               :example_request)
YARD::Tags::Library.define_tag("Example Request Description",   :example_request_description)
YARD::Tags::Library.define_tag("Request Fields",                :request_field,     :with_types_and_name)

YARD::Tags::Library.define_tag("Example Response",              :example_response)
YARD::Tags::Library.define_tag("Example Response Description",  :example_response_description)
YARD::Tags::Library.define_tag("Response Fields",               :response_field,    :with_types_and_name)

YARD::Tags::Library.define_tag("Headers",                       :header, :with_name)

Version data entries

11 entries across 11 versions & 1 rubygems

Version	Path
yard-rest-1.1.4	lib/yard-rest/tags.rb
yard-rest-1.1.3	lib/yard-rest/tags.rb
yard-rest-1.1.2	lib/yard-rest/tags.rb
yard-rest-1.1.1	lib/yard-rest/tags.rb
yard-rest-1.1.0	lib/yard-rest/tags.rb
yard-rest-1.0.5	lib/yard-rest/tags.rb
yard-rest-1.0.4	lib/yard-rest/tags.rb
yard-rest-1.0.3	lib/yard-rest/tags.rb
yard-rest-1.0.2	lib/yard-rest/tags.rb
yard-rest-1.0.1	lib/yard-rest/tags.rb
yard-rest-1.0.0	lib/yard-rest/tags.rb