Contents

# Class: Fish
**Inherits:** Object
    
**Defined in:** example_yard.rb

The base class for all fish.

# Public Instance Methods
## make_sound() [](#method-i-make_sound)
Make a sound.

**@return** [void] 
**@yield** [sound] The sound produced by the fish
**@yieldparam** [String] The actual sound
## swim(direction, speed) [](#method-i-swim)
Swim in a specific direction.

Swimming is the most critical feature of fish.

**@param** [Symbol, String] The direction to swim
**@param** [Integer] The speed at which to swim
**@return** [Boolean] Whether the swim was successful

**@example**
```ruby
swim(:north, 30)
```

# Constants
| Name | Default Value |
| ---  | ---   |
| [DEFAULT_SALMON_SPEED](#constant-DEFAULT_SALMON_SPEED) | 20 |
| [MAX_DEPTH](#constant-MAX_DEPTH) | 500 |

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
yard-markdown-0.4.1	example/Fish.md