cholla-hydro / cholla

A GPU-based hydro code
https://github.com/cholla-hydro/cholla/wiki
MIT License
65 stars 32 forks source link

Add doxygen comments to dust code #282

Closed helenarichie closed 1 year ago

helenarichie commented 1 year ago

Updated existing comments in dust_cuda.cu and added Doxygen comments to dust_cuda.h, dust_cuda.cu, and dust_cuda_tests.cpp. I'm unsure I used \param[in] and \param[out] appropriately in the function doc strings dust_cuda.h. I think that \param[out] should be used for an input parameter that I'm modifying, but not returning in the function, but in the case of dev_conserved I don't know if I should specify the field that I'm modifying or something like that. If anyone has thoughts on this, please let me know!

bcaddy commented 1 year ago

Here's what the \param in/out stuff means

dev_conserved is almost always either [in] or [in,out].

evaneschneider commented 1 year ago

It looks like this failed on one of Bob's new MHD tests - can you try updating the submodule again?

evaneschneider commented 1 year ago

(It's probably my fault for auto-merging in the most recent PR - I guess that doesn't update the submodule.)