search

JeffersonLab / hpstr

Heavy Photon Search Toolkit for Reconstruction
2 stars 19 forks source link

adjusted comment style and added placeholder comments #152

Closed sarahgaiser closed 2 years ago

sarahgaiser commented 2 years ago

I adjusted the comment style so that the comments are Doxygen readable. Some of the comments are placeholder comments which need to be replaced by people with more expertise at some point. This should be easy as everything is now prepared for this. In addition to that, I edited some of the formatting of the code to increase general readability.

This PR looks huge because I touched a lot of code but assuming I haven't accidentally broken anything, the functionality should not have changed.

sarahgaiser commented 2 years ago

I added another file doxygen_main_page.h which will hopefully add some more information to the Doxygen main page. For this, I needed to adjust the Doxyfile slightly but that should not make a big difference.