search

OPEnSLab-OSU / Loom-V4

Open Source Internet Of Things Rapid Prototyping Framework For Environmental Sensing Applications
5 stars 1 forks source link

Update Doxygen For Hypnos #132

Open ZakaryW opened 4 months ago

ZakaryW commented 4 months ago

Currently the doxygen documentation does not cover the enums that are outside the Hypnos class, but are used within the Hypnos functionality. So to fix this, we need to regenerate the doxygen and ensure it includes these enums.

ZakaryW commented 4 months ago

Some extra context,

The config file is located in the root directory of the repo, Doxyfile. This is the current Hypnos Documentation, the enums which are in the Hypnos header file aren't documented here so we want to change that. It might be worth looking through Doxygen's documentation for documenting code as well.

WL-Richards commented 3 months ago

You will likely have to change some of the directory and file paths in the Doxyfile as they are absolute paths on my machine