Sha256: c2699e93b2937f97da83f5515cde1d1723b03a7cd7d173c09f1360960f44cbf2

Contents?: true

Size: 583 Bytes

Versions: 1

Compression:

Stored size: 583 Bytes

Contents

# Class: Fish
**Inherits:** Object
    

The base class for all fish.



#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)
```

Version data entries

1 entries across 1 versions & 1 rubygems

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