sleef
sleef copied to clipboard
Doxygen documentation
As part of the LLVM- compatibility effort, we decided to move SLEEF documentation to doxygen.
This task is the initial experimental support for doxygen.
We are not sure that this is what we want to use for the project, therefore to avoid wasting time we limit the scope of this initial investigation to the following:
- add doxygen documentation only in
sleefsimddp.c - add the docs only for
sin,cos, andexp. For each functions, add the precision and the range where this precision is valid. - create a
cmakeconfiguration to build the documentation as themake docstarget. That should required:- a
CMakeLists.txtconfiguration file in thedocfolder with the definitiona of thedocstarget that invokesdoxygen. - a
CMakeLists.txtin the root folder that will include thedocfolder.
- a
Once we are happy with this configuration, we can think at extending it to the whole library.