hackrf
hackrf copied to clipboard
Reorganize libhackrf API documentation
Use functions as headings, remove existing headings, fill out contents.
It might be worth setting up Doxygen (or similar) to generate API docs from the source? I think it would make it easier to keep everything in sync as the API changes. There are some plugins that integrate it with sphinx/readthedocs, e.g: https://breathe.readthedocs.io/en/latest/index.html
This looks like a good guide: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/