1. Home
  2. Classes
  3. MyApi.Class

new Class( arg1 [, ...arg2 ] )

This is the summary of the MyApi test class, test markdown.

Description

This is the description for the class this is meant to be a more in depth explanation of what this class does and it's general use case, test markdown

Parameters
Name Type Attributes Default Description
arg1 string

The first test arg, test markdown.
arg2 string <optional>
<repeatable>
 false

A repeatable, optional argument with a default value of false, test markdown.
Examples

You can provide example captions with markdown and specify the language to use when rendering the code, defaults to javascript.


var gc = new GlobalClass("arg1", "arg2");

<head>
	<title>HTML Highlighting</title>
	<script>
	  // supports embedded languages
		var gc = new GlobalClass("arg1", "arg2");
	</script>
</head>
Details

MyApi.js, line 25

Members

publicMember :string

I'm a member of the class.

Details
string

"I'm an instance member."

MyApi.js, line 44

<protected> protectedMember :string

I'm a protected member of the class.

Details
string

"I'm a protected member."

MyApi.js, line 52

<private> _privateMember :string

I'm a private member of the class.

Details
string

"I'm a private member."

MyApi.js, line 61

Methods

testMethod( value, obj [, ...objN ] ) → {Object}

This is a test instance method of the MyApi test class, test markdown.

Description

This method is not overridden in the MyApi.Child class but is simply inherited.

Parameters
Name Type Attributes Description
value *

Any value, test markdown
obj Object

The first object of what could be many, test markdown
objN Object <optional>
<repeatable>

Any additional objects, test markdown
Returns

The combination of all the objects, test markdown.

Fires

This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.

Throws

This is thrown when some condition fails within this method.

Details

MyApi.js, line 72

anotherMethod( value, obj [, ...objN ] ) → {Object}

This is a another test instance method of the MyApi test class, test markdown.

Description

This method is overridden in the MyApi.Child class and should remove the exception documentation as it no longer applies.

Parameters
Name Type Attributes Description
value *

Any value, test markdown
obj Object

The first object of what could be many, test markdown
objN Object <optional>
<repeatable>

Any additional objects, test markdown
Returns

The combination of all the objects, test markdown.

Fires

This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.

Throws

This is thrown when some condition fails within this method.

Details

MyApi.js, line 95

Type Definitions

Object

This is a test type definition on the MyApi.Class class.

Properties
Name Type Attributes Default Description
name string

The name of the test object.
enabled boolean <optional>
 false

Whether or not the test object is enabled. Defaults to false.
sub Object

An object containing a subset of properties.

Name Type Attributes Default Description
id number

The subset id.
name boolean <optional>
 "Sub Options"

The name of the sub object. Defaults to "Sub Options".
Details
Object

MyApi.js, line 117

Events

"test.my-api"

This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.

Parameters
Name Type Description
e Event

The event object.
custom *

Some custom parameter passed to any listeners.
Details

MyApi.js, line 85

"another.my-api"

This is an event raised by this class, it's documentation appears on this page as the event is specified as an inner member the class by using the tilde (~) scope.

Parameters
Name Type Description
e Event

The event object.
custom *

Some custom parameter passed to any listeners.
Details

MyApi.js, line 108