functionTemplate_v1.m File Reference

A short description of the general idea behind the function. More...

Go to the source code of this file.

Functions
function	functionTemplate_v1 (in param1, in param2, in param3Enabled)
	Brief description of the function. More...

Detailed Description

A short description of the general idea behind the function.

{|||||}

Information concerning the function, but not specific on the function implementation. See robolog.m for an example. The implementation is based on [BookAuthor1].

Observations

1. First observation
2. Second observation

Conventions

• First convention
• Second convention

Example

% Here we put a FULLY WORKING example
param1 = XX;
param2 = YY;
output = myFunction(param1, param2);

References

• [1] First formatted reference
• [2] Second formatted reference

Author

Author 1

Author 2

See also

robolog.m

Version

1

Definition in file functionTemplate_v1.m.

Function Documentation

function functionTemplate_v1	(	in	param1,
		in	param2,
		in	param3Enabled
	)

Brief description of the function.

More detailed description of the function. Examples should not go here.

Parameters

param1	Param1 description (capital first letter) [unit]. [Default: Value]
param2	Param2 description (capital first letter) [unit].
param3Enabled	Description of a flag to enable or disable something. [Default: Value]

Return values

output1	Output value 1
output2	Output value 1