Add-on SDK Documentation

# APIsample

# Title

Some text here

This text appears between the API blocks.

Wooo, more text.

Some more text here, at the end of the file.

## API Reference

### Classes

#### empty-class

This class contains nothing.

#### only-one-ctor

This class contains only one constructor.

Constructors
one-constructor(options)
options

An object-bag of goodies.

#### two-ctors

This class contains two constructors.

Constructors
one-constructor(options)

The first constructor.

options

An object-bag of goodies.

another-constructor(options)

The second constructor.

options

An object-bag of goodies.

#### ctor-and-method

This class contains one constructor and one method.

Constructors
one-constructor(options)

The first constructor.

options

An object-bag of goodies.

Methods
a-method(options)

Does things.

options

An argument.

#### ctor-and-method-and-prop

This class contains one constructor, one method, and one property.

Constructors
one-constructor(options)

The first constructor.

options

An object-bag of goodies.

Methods
a-method(options)

Does things.

options

An argument.

Properties
a-property : bool

Represents stuff.

### Functions

#### test(argOne, argTwo, argThree, options)

This is a function which does nothing in particular.

argOne : string

This is the first argument.

argTwo : bool

This is the second argument.

argThree : uri

This is the third and final argument. And this is a test of the ability to do multiple lines of text.

options

Options Bag

style : string

Some style information.

secondToLastOption : bool

The last property.

lastOption : uri

And this time we have A multiline description Written as haiku

Returns: object

#### append(options)

This is a list of options to specify modifications to your slideBar instance.

options

Pass in all of your options here.

icon : uri

The HREF of an icon to show as the method of accessing your features slideBar

html : string/xml

The content of the feature, either as an HTML string, or an E4X document fragment (e.g., <>

# Hi!

)
url : uri

The url to load into the content area of the feature

width : int

Width of the content area and the selected slide size

persist : bool

Default slide behavior when being selected as follows: If true: blah; If false: double blah.

autoReload : bool

Automatically reload content on select

onClick : function

Callback when the icon is clicked

onSelect : function

Callback when the feature is selected

onReady : function

Callback when featured is loaded

#### cool-func.dot(howMuch, double, options, onemore, options2)

howMuch : string

How much cool it is.

double : bool

In case you just really need to double it.

options

An object-bag of goodies.

callback : function

The callback

random : bool

Do something random?

onemore : bool

One more paramater

options2

This is a full description of something that really sucks. Because I now have a multiline description of this thingy.

monkey : string

You heard me right

freak : bool

Yes, you are a freak.

Returns: string A value telling you just how cool you are. A boa-constructor! This description can go on for a while, and can even contain some **realy** fancy things. Like `code`, or even ~~~~{.javascript} // Some code! ~~~~

#### random()

A function that returns a random integer between 0 and 10.

Returns: int The random number.