4. Inline Documentation for DaisySP Module Headers

Reference Documentation for DaisySP is parsed from inline markdown in each module's header file.

All comments that have text after a space will be parsed as Markdown into the generated reference documentation.

Only Header files are parsed.

Here's an example of the format that should be used when documenting a module:

---

Module/Class Name

Description

Something about the module blahblah

Credits

Author/Source: Person Person

Date Added: December 2019

Data Types

enums, templates, types, etc. etc each in their own subsection:

Curve

blah

Something Else

Functions

Init

Description of Function

arg1: rate in Hz -- default: 1.0

void Init(float arg1);

Process

Description of Function

float Process();

Parameters

Parameter Name

Description

Range

Units

void SetParameter(float foo);
float GetParameter();

etc.

TODO:

• List Item
• Another List Item
• etc.