Module: Shaf::Yard

Defined in:

lib/shaf/yard.rb,
lib/shaf/yard/parser.rb,
lib/shaf/yard/link_object.rb,
lib/shaf/yard/profile_object.rb,
lib/shaf/yard/resource_object.rb,
lib/shaf/yard/attribute_object.rb,
lib/shaf/yard/nested_attributes.rb,
lib/shaf/yard/serializer_handler.rb,
lib/shaf/yard/base_method_handler.rb,
lib/shaf/yard/link_method_handler.rb,
lib/shaf/yard/profile_method_handler.rb,
lib/shaf/yard/attribute_method_handler.rb

Defined Under Namespace

Modules: NestedAttributes Classes: AttributeMethodHandler, AttributeObject, BaseMethodHandler, LinkMethodHandler, LinkObject, Parser, ProfileMethodHandler, ProfileObject, ResourceObject, SerializerHandler

Constant Summary

CUSTOM_TAGS =

[
  ['Request Header', :request_header, :with_name],
  ['Reponse Header', :response_header, :with_name],
  ['Example Request', :example_request],
  ['Example Response', :example_response],
  ['Description', :description],
  ['HTTP method', :http_method],
  ['Attribute type', :type, :with_types]
].freeze

TEMPLATE_PATH =

File.join(Utils.gem_root, 'yard_templates').freeze