This PR creates a GitHub Action that generates documentation for the library and deploys it to GitHub Pages.
The existing comments in the code have been improved with doxygen-style tags, for better clarity. A Doxyfile was also added so doxygen could be used to generate documentation.
Some aspects were undocumented such as template type parameters, so those were added as well.
Finally, the readme was modified slightly to play nice with the Doxygen markdown renderer.
After this PR is merged, GitHub pages needs to enabled on the repository in order for the documentation to be hosted. The source directory should be configured as the repo root, and the jekyll theme should be set to any arbitrary option, since it doesn't matter.
This PR creates a GitHub Action that generates documentation for the library and deploys it to GitHub Pages.
Doxyfilewas also added so doxygen could be used to generate documentation.After this PR is merged, GitHub pages needs to enabled on the repository in order for the documentation to be hosted. The source directory should be configured as the repo root, and the jekyll theme should be set to any arbitrary option, since it doesn't matter.