Sha256: 29674c959d67272219a69c82903cb09ad0edddac6d021c939d01ca7c9c5b0f26

Contents?: true

Size: 1.25 KB

Versions: 1

Compression:

Stored size: 1.25 KB

Contents

# Class: Salmon
**Inherits:** Fish
    
**Includes:** Aquatic
  
**Defined in:** example_yard.rb

A salmon is an Aquatic Fish.

## Features

*   **Fish**
    *   make_sound
    *   swim
*   **Aquatic**
    *   swim (overridden)

# Public Instance Methods
## initialize(farmed, wild) [](#method-i-initialize)
Creates a new salmon.

**param** [Boolean] Whether the salmon is farmed
**param** [Boolean] Whether the salmon is wild
**return** [Salmon] a new instance of Salmon
## make_sound() [](#method-i-make_sound)
Salmon overrides generic implementation.

**return** [void] 
**yield** [sound] The sound produced by the salmon
**yieldparam** [String] The actual sound
## sustainable?() [](#method-i-sustainable?)
Checks if this salmon is sustainable.

**return** [Boolean] Whether the salmon is sustainable
## swim() [](#method-i-swim)
Swim in the water.

**return** [void] 

# Public Class Methods
## wild_salmon() [](#method-c-wild_salmon)
**return** [Array<Salmon>] List of all wild salmon

# Attributes
## farmed[RW] [](#attribute-i-farmed)

**return** [Boolean] True for farmed salmon
## wild[RW] [](#attribute-i-wild)

**return** [Boolean] True for wild salmon

# Constants
## DEFAULT_SALMON_SPEED [](#constant-DEFAULT_SALMON_SPEED)


## MAX_DEPTH [](#constant-MAX_DEPTH)


Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
yard-markdown-0.4 example/Salmon.md