Contents

# Define custom tags
tags = [
  ["Declaration of RESTful API type",:restful_api],
  ["URL",                           :url],
  ["HTTP-Action for the Resource",  :action],

  #["Object Used in Resource",       :resource_object],
  ["Resource Object Property",      :property, :with_types_and_name],
  ["Resource Object Example",       :example],

  ["Required Arguments",            :required,          :with_types_and_name],
  ["Optional Arguments",            :optional,          :with_types_and_name],

  ["Example Request",               :example_request],
  ["Example Request Description",   :example_request_description],
  ["Request Fields",                :request_field,     :with_types_and_name],

  ["Example Response",              :example_response],
  ["Example Response Description",  :example_response_description],
  ["Response Fields",               :response_field,    :with_types_and_name],
  ["Response Type",                 :response,    :with_types]
]

tags.each do |tag|
    YARD::Tags::Library.define_tag(*tag)
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
yard-restful-1.2.4	lib/yard-restful/tags.rb
yard-restful-1.2.3	lib/yard-restful/tags.rb
yard-restful-1.2.2	lib/yard-restful/tags.rb
yard-restful-1.2.1	lib/yard-rest/tags.rb
yard-restful-1.2.0	lib/yard-rest/tags.rb