Apply format for all doxygen documents.
Every document has the following structure.
Signature of the function
@brief description
@params parameters
@pre preconditions
@returns possible return values
@note notes
@see-also
- Test the compiler for AVX2/AVX512 support instead of unconditionally
defining `XXH_DISPATCH_*`(fixes#464)
- Can also be enabled/disabled on the command line
- Use a macro template to reduce code repetition
- Don't dispatch the scalar path when we don't need it. It can be
rather wasteful, especially on 32-bit.
- Specifically, don't dispatch when SSE2 is globally enabled on the
compiler or when it is guaranteed on the platform.
- Add some Doxygen documentation for xxh_x86dispatch.c.
XXH32's API, XXH*_state_s, the config macros, and some other things are
documented in Doxygen format, basic Doxyfile added.
Some functions were also redocumented in detail.
Still need to work on structuring the main page (set it to README.md?).
How to view 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
