search

scipr-lab / libff

C++ library for Finite Fields and Elliptic Curves
Other
149 stars 82 forks source link

Did minor comment cleanup on staging for v1.1 #62

Closed AntoineRondelet closed 3 years ago

AntoineRondelet commented 3 years ago

Did some minor comment re-arrangement on staging for the v1.1 PR. Some comments were written on the same line separated by 4 spaces, some were separated by 6 spaces, some were written on the line above. That was inconsistent so I just moved all comments on the line above (which is also nice to have if we want to configure tools like clang-tidy later on, as such tools may either complain or format our code in a weird way because the lines are too long due to the fact that comments are written on the same line etc..).

Additionally, I'd be in favor to be careful with comment blocks styles. In fact, we need to comply with a certain syntax is we want to use Doxygen down the line to generate the project's documentation: https://www.doxygen.nl/manual/docblocks.html

Related to #57

ValarDragon commented 3 years ago

Thanks for fixing this! Didn't realize doxygen/downstream tooling cared about comment block styles, I'll watch out for this in the future.

Completely agreed we should setup some code style linters as well. (Would you recommend clang-tidy?)

AntoineRondelet commented 3 years ago

(Would you recommend clang-tidy?)

Yes definitely