Skip to content

Docs/architecture

Tyler Tsui requested to merge docs/architecture into develop

Context

Add documentations for the data structure in the project. Extended Architecture documentation to include brief overviews on the benefits the design patterns will bring to a project and updated the Architecture high level UML to reflect the current project.

Summary

Documented the Channel, Event and Pulse data structures. Did as much as I could with Waveform but that there was a lot of methods related to math that I was unfamiliar with. Waveform will need further documentation by someone more familiar with its functionality for completion. Upgraded the Architecture UMP to reflect the current state of the project (December 1, 2020). Added a brief overview of the Design Patterns and explanation on how they fit/were used in the current code.

How was this tested?

Ran make docs locally and looked at changes to the docs to see if it generated/was formatted properly.

Merge request reports