dmd-bitbucket/test/class-furq.md

Plugin for jsdoc2md to produce markdown suitable for bitbucket

## FurQ ⇐ Rapper
C\*ck, b!tch, c\*ck, b!tch, m\*therf!cker. You gotta kill people, to respect people.

**Kind**: global class  
**Extends**: Rapper  
**Emits**: FurQ#event:pop, FurQ#event:slap  
**Access**: public  
**See**: [https://www.youtube.com/watch?v=1sxZ4tsp8gc](https://www.youtube.com/watch?v=1sxZ4tsp8gc)
**Author**: Chris Morris  

* [FurQ](#markdown-header-furq-rapper) ⇐ Rapper
    * [new FurQ()](#markdown-header-new-furq)
    * _instance_
        * [.wannaTryIt](#markdown-header-furqwannatryit-stringfunction) : string ⎮ function
        * [.LOVE](#markdown-header-furqlove-string) : string
        * [.spit()](#markdown-header-furqspit)
        * [.battle()](#markdown-header-furqbattle)
        * [.punch()](#markdown-header-furqpunch)
        * _standard_
            * [.kill()](#markdown-header-furqkill)
            * [.respect(done)](#markdown-header-furqrespectdone)
    * _static_
        * [.enemy](#markdown-header-furqenemy-enum) : enum
        * ~~[.peace()](#markdown-header-furqpeace)~~
    * _inner_
        * [~onRespect](#markdown-header-furqonrespect-function) : function

### new FurQ()
She's an Uzi lover.

![uzi](https://sampleface.co.uk/wp-content/uploads/2013/07/fur-q-uzi-lover.png)

**Example**  
```js
var uziLover = require("FurQ");
```
### furQ.wannaTryIt : string ⎮ function
**Kind**: instance property of [FurQ](#markdown-header-new-furq)  
**Default**: `"bitch"`  
**See**

- "Uzi like a metal dick in my hand."
- "Magazine like a big testicle gland."

### furQ.LOVE : string
**Kind**: instance constant of [FurQ](#markdown-header-new-furq)  
**Default**: `"UZI"`  
### furQ.spit()
override

**Kind**: instance method of [FurQ](#markdown-header-new-furq)  
**Overrides**: spit  
### furQ.battle()
battle

**Kind**: instance method of [FurQ](#markdown-header-new-furq)  
### furQ.punch()
to plant ones fist in a buster's mush

**Kind**: instance method of [FurQ](#markdown-header-new-furq)  
### furQ.kill()
kill

**Kind**: instance method of [FurQ](#markdown-header-new-furq)  
**Category**: standard  
**Example**  
```js
var kill = uziLover.kill();
    
```
**Example**  
```js
uziLover.kill();
```
### furQ.respect(done)
respect

**Kind**: instance method of [FurQ](#markdown-header-new-furq)  
**Category**: standard  

| Param | Type | Description |
| --- | --- | --- |
| done | onRespect | called on reciprocation of respect |

**Example**  
```js
uziLover.respect(function(err, gain){
    console.log(gain);
});
```
### FurQ.enemy : enum
FUR-Q enemy types

**Kind**: static enum of [FurQ](#markdown-header-new-furq)  
**Read only**: true  
**Properties**

| Name | Type | Default | Description |
| --- | --- | --- | --- |
| COCK | number | `0` | an awful individual |
| BITCH | number | `1` |  |
| MUTHAFUCKA | number | `2` |  |

### ~~FurQ.peace()~~
***Deprecated***

check if at peace

**Kind**: static method of [FurQ](#markdown-header-new-furq)  
**Example**  
```js
var peace = FurQ.peace();
```
### FurQ~onRespect : function
Passed to [respect](#FurQ+respect)

**Kind**: inner typedef of [FurQ](#markdown-header-new-furq)  

| Param | Type | Description |
| --- | --- | --- |
| err | Error | an issue with the punch |
| gain | * | the respect percentage gained |

## Rapper
**Kind**: global class  

* [Rapper](#markdown-header-rapper)
    * _instance_
        * [.spit()](#markdown-header-rapperspit)
        * [.battle()](#markdown-header-rapperbattle)
    * _static_
        * [.train()](#markdown-header-rappertrain)
            * [~School](#markdown-header-trainschool)
                * [new School()](#markdown-header-new-school)
                * [.bestStudent](#markdown-header-schoolbeststudent)

### rapper.spit()
spit

**Kind**: instance method of [Rapper](#markdown-header-rapper)  
### rapper.battle()
battle

**Kind**: instance method of [Rapper](#markdown-header-rapper)  
### Rapper.train()
train new rappers

**Kind**: static method of [Rapper](#markdown-header-rapper)  

* [.train()](#markdown-header-rappertrain)
    * [~School](#markdown-header-trainschool)
        * [new School()](#markdown-header-new-school)
        * [.bestStudent](#markdown-header-schoolbeststudent)

#### train~School
**Kind**: inner class of train  

* [~School](#markdown-header-trainschool)
    * [new School()](#markdown-header-new-school)
    * [.bestStudent](#markdown-header-schoolbeststudent)

##### new School()
rap school

##### school.bestStudent
best student

**Kind**: instance property of [School](#markdown-header-new-school)  
## plant()
to plant ones fist in a buster's mush

**Kind**: global function