hackrf icon indicating copy to clipboard operation
hackrf copied to clipboard

Reorganize libhackrf API documentation

Open straithe opened this issue 3 years ago • 2 comments

Use functions as headings, remove existing headings, fill out contents.

straithe avatar Jul 03 '21 18:07 straithe

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

miek avatar Jul 05 '21 16:07 miek

This looks like a good guide: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

mossmann avatar Jul 05 '21 17:07 mossmann