1. Home
  2. Classes
  3. GlobalClass

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

This is the summary of the global 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

GlobalClass.js, line 1

Members

name :string

The name of the class.

Details
string

"Test Global"

GlobalClass.js, line 19

<private> _privateMember :string

A private member of the class.

Details
string

"Test Global"

GlobalClass.js, line 27

Methods

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

This is a test instance method of the global test class, test markdown

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.

Details

GlobalClass.js, line 38

testMethod( type )

This is a test instance method of the global test class to check that global type definitions are documented.

Parameters
Name Type Description
type SomeType

The parameter which is of type SomeType
Details

GlobalClass.js, line 51