Skip to content

Commit

Permalink
adding documentation to Tankard::Api::Adjunct. [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewshafer committed Jan 5, 2015
1 parent d15b67f commit 9b340b7
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions lib/tankard/api/adjunct.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,22 @@ module Api
# @see http://www.brewerydb.com/developers/docs-endpoint/adjunct_index
# @author Matthew Shafer
class Adjunct < Tankard::Api::Base::Find
# @!method initialize(request, options = {})
# Initializes a new object
#
# @param request [Tankard::Request]
# @param options [Hash]
# @return [Tankard::Api::Adjunct]

# @!method find(id_or_array, options={})
# Find a single or multiple adjunct's by their id
#
# @param id_or_array [String, Array]
# @param options [Hash]
# @return [Hash, Array] if a string with a adjunct id is passed to find then the hash of the adjunct's data is returned.
# if an array is passed to find an array containing hashes with each adjunct's data is returned.
# if an adjunct is not found nothing for that adjunct is returned.

private

def route
Expand Down

0 comments on commit 9b340b7

Please sign in to comment.