[WIP] Doxygen and more detailed documentation #462

Merged

easyaspi314 merged 6 commits from doxygen-cleanup into dev

2020-10-16 16:52:22 -05:00

easyaspi314 commented

2020-10-15 17:47:28 -05:00

(Migrated from github.com)

XXH32's API, XXH*_state_s, the config macros, and some other things are documented in Doxygen format, and a basic (albeit messy for now) Doxyfile was added.

Some things were also [re]documented in detail.

Still need to work on structuring the main page (set it to README.md?), and cleaning things up.

How to view the docs for now:

 $ sudo apt install doxygen
 $ npm install -g http-server # or you can use LLVM's scan-view
 $ doxygen && hs doxygen/html -s -c-1 -o # will open a browser

XXH32's API, XXH*_state_s, the config macros, and some other things are documented in Doxygen format, and a basic (albeit messy for now) Doxyfile was added. Some things were also [re]documented in detail. Still need to work on structuring the main page (set it to README.md?), and cleaning things up. How to view the docs for now: ``` $ sudo apt install doxygen $ npm install -g http-server # or you can use LLVM's scan-view $ doxygen && hs doxygen/html -s -c-1 -o # will open a browser ```

👍 1

Cyan4973 (Migrated from github.com) approved these changes

2020-10-15 18:56:25 -05:00

Cyan4973 (Migrated from github.com) left a comment