Template

Table of Contents

Table of Contents

1 Overview

A short overview of the functionality this provides.

State requirement clearly and simply, followed by justification. Avoid getting into design or implementation details

State requirement clearly and simply, followed by justification. Avoid getting into design or implementation details

Clear statement of desired feature and reason for including (e.g. design needs to take this into account for future capability).

Describe any algorithms or point to references that are important for implementation

You can include math in Latex format like his:

\[\begin{split} (a + b)^2 &= (a + b)(a + b) \\ &= a^2 + 2ab + b^2 \end{split}\]

You can include code blocks like this:

int var = value;

List and define any configuration parameters or public constants.

Describe any public data types and/or the class definition

List and describe all public methods and their interfaces (actual code for interface that would be in header file). Describe typical use cases.

Describe test including conditions for pass/fail List which requirements it tests:

Describe test including conditions for pass/fail List which requirements it tests: