Template Class

Package: kwave.toolbox Superclasses: kwave.toolbox.SuperClass (delete if not applicable)

Short description of class or function.

Syntax

obj = templateClass(inputArg1);

Description

Longer description of class or function, describing how it works.

Class methods (other than setters and getters) should be implemented and documented in separate files.

Inputs, outputs, properties and methods should use camelCase. Name-value arguments should use TitleCase.

Examples

Include examples of using the class or function. Use three spaces after % so that code automatically formats.

inputArg1 = rand;
obj = templateClass(inputArg1);
obj.doSomething;

Input Arguments

inputArg1 - (dataType) Description of input. Include units if applicable. For descriptions that span multiple lines, align with three spaces.

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Name1 - (dataType) Description of input. Include units if applicable. For descriptions that span multiple lines, align with three spaces.

Output Arguments

outputArg1 - (dataType) Description of output. Include units if applicable.

Properties (Classes Only)

property1 - (propertyDataType) Description of property. Include units if applicable.

Methods (Classes Only)

doSomething