Example Documentation

Dummy functions to Explain Documentation. More...

Functions
	BasicFunction ()
	This is an basic example function.
outValue	GreatFunction (inArg)
	This is a regular example function.
outOne outTwo	SuperDuperFunction (inOne, inTwo)
	This is a longer example function.

Detailed Description

Dummy functions to Explain Documentation.

RenderToolbox3 functions are documented in groups of related functions called Modules. Each module gets its own page with:

• A list of Funcitons (above). Output values appear on the left-hand side. Function names and parameters appear on the right-hand side. Function names are links to detailed documentation.
• A Detailed Description of the module (this section).
• Function Documentaion detailing each function (below). The documentation describes function parameters, what the function does, and what the function returns, and shows the Matlab usage syntax.

Function Documentation

BasicFunction

(

)

This is an basic example function.

This is an example function to help explain how the function reference works. It takes no arguments and returns nothing.

Usage: basicFunction()

outValue GreatFunction

(

inArg

)

This is a regular example function.

Parameters

inArg

an input argument

This is an example function to help explain how the function reference works. It takes one argument, inArg.

It returns one output value.

Usage: outValue = GreatFunction(inArg)

outOne outTwo SuperDuperFunction	(	inOne	,
		inTwo
	)

This is a longer example function.

Parameters

inOne	the first input argument
inTwo	the second input argument

This is an example function to help explain how the function reference works. It takes two arguments, inOne and inTwo.

It returns two output values.

Usage: [outOne, outTwo] = SuperDuperFunction(inOne, inTwo)