API documentation for ktruss - Githubissues

c3sr / pangolin

6 stars 0 forks source link

API documentation for ktruss #28

Open cwpearson opened 5 years ago

cwpearson commented 5 years ago

The primary functions and parameters in these files should be documented in the Doxygen style.

See https://github.com/c3sr/pangolin/blob/6fe6c098e3f89cfab8b81bdde4b46fffa23be65b/include/pangolin/algorithm/zero.cuh#L29-L44 for example.

[ ] include/pangolin/algorithm/ktruss_serial.cuh
[ ] include/pangolin/algorithm/ktruss_serial._inc_loop.cuh
[ ] include/pangolin/algorithm/ktruss_serial.Incremental.cuh
[ ] include/pangolin/algorithm/ktruss_binary.cuh

It would also be good to include a Doxygen file block at the top.

/*! \file This file implements blah blah blah
*/