Example Docs: Class - Geometry.ExampleClass

Class: Geometry.ExampleClass

ClassyTemplate Example Class

Summary:
An example of a JavaScript class that is a member of the API entrypoint

Documented classes can also include more verbose descriptions that are included in the documentation, as below.

Lorem Ipsum

Salutatus quem ultrices mentitum discere sodales perpetua audire sed torquent. No recteque dicunt pri a pulvinar penatibus. Litora interpretaris veritus scripserit falli duis.

Moderatius Facilis Possim

Eam vix percipit eius mel civibus cras tellus voluptaria postea. Meliore sale no adipiscing ex deserunt natoque scripserit fusce falli.

Causae Error

Error causae dissentiunt justo fabulas conubia. Graece congue dicit harum saperet sumo adolescens eloquentiam. Torquent quaeque magnis errem mandamus malesuada.

Usage

Constructs an instance of ExampleClass from the supplied parameters

                    
                        new Geometry.ExampleClass(param1, param2opt, param3opt)

Source:: example/src/example.js, line 1

Parameters:

Name Type Default Description


                        param1

String

an example of a string parameter


                        param2opt

Object

{}

an example of an object parameter

Properties

Name	Type	Description
`prop1opt`	String	a string property of an object parameter
`prop2opt`	Number	a number property of an object parameter


                        param3opt

Boolean

false

an example of a boolean parameter

Properties:

Name	Type	Description
`prop1`	String	an example of a string property
`prop2`	Boolean	an example of a boolean property
`prop3`	~ExampleType	an example of an object property

Examples:

An example with a caption

// Captions must be wrapped in <caption></caption> tags
new ExampleClass("example");

// An example without a caption
new ExampleClass("example");

Members

(static) titles: String[]

An example of a static member of a class, with a default value

Type:: {String[]}
Source:: example/src/example.js, line 60
Default Value:: ["An Example"]

Methods

hello(name)

Says hello

Source:: example/src/example.js, line 66

Parameters:

Name	Type	Description
`name`	String	who to say hello to

(static) add(x, y) → {Number}

Adds two numbers together

Source:: example/src/example.js, line 76

Parameters:

Name	Type	Description
`x`	Number	first number
`y`	Number	second number

Returns:

first and second number added together

Type:

{Number}

Type Definitions

ExampleType

Type:: {Object}
Source:: example/src/example.js, line 45

Properties:

Name	Type	Description
`str`	String	a string property of an object property
`num`	Number	a number property of an object property

Constants

(inner) ExampleStrings: String[]

Collection of strings documented for the example class

Values:: ["and","or","not"]
Type:: {String[]}
Source:: example/src/example.js, line 90