Generate an on-line documentation with Doxygen

[ninokin25]

Overview

We need to put comments in our code such that doxygen incorporates them in the documentation it generates.

Expected behavior

• [ ] Can generate the documentation from our code/comments.

Solutions you've considered

• Step 0: Check if doxygen supports your programming/hardware description language
• Step 1: Creating a configuration file
• Step 2: Running doxygen
  • HTML output
  • LaTeX output
  • RTF output
  • XML output
  • Man page output
  • DocBook output
• Step 3: Documenting the sources

Additional context

cf. https://www.doxygen.nl/manual/docblocks.html