remove blank line between function and it's description

- remove the blank line between the declaration of the function and it's
  comment, leads to better IDE support when hovering over a function to see it's
  description
- remove the unnecessary duplication of the function name in the functions
  description
- slightly refactored code for lsb, msb in bitboard.h There are still a few
  things we can be improved later on, move the description of a function where
  it was declared (instead of implemented) and add descriptions to functions
  which are behind macros ifdefs

closes https://github.com/official-stockfish/Stockfish/pull/4840

No functional change
This commit is contained in:
Disservin
2023-10-22 20:20:53 +02:00
parent b187622233
commit a105978bbd
24 changed files with 175 additions and 271 deletions

View File

@@ -60,8 +60,7 @@ bool CaseInsensitiveLess::operator()(const string& s1, const string& s2) const {
}
// UCI::init() initializes the UCI options to their hard-coded default values
// Initializes the UCI options to their hard-coded default values
void init(OptionsMap& o) {
constexpr int MaxHashMB = Is64Bit ? 33554432 : 2048;
@@ -89,9 +88,8 @@ void init(OptionsMap& o) {
}
// operator<<() is used to print all the options default values in chronological
// Used to print all the options default values in chronological
// insertion order (the idx field) and in the format defined by the UCI protocol.
std::ostream& operator<<(std::ostream& os, const OptionsMap& om) {
for (size_t idx = 0; idx < om.size(); ++idx)
@@ -172,7 +170,7 @@ bool Option::operator==(const char* s) const {
}
// operator<<() inits options and assigns idx in the correct printing order
// Inits options and assigns idx in the correct printing order
void Option::operator<<(const Option& o) {
@@ -183,10 +181,9 @@ void Option::operator<<(const Option& o) {
}
// operator=() updates currentValue and triggers on_change() action. It's up to
// Updates currentValue and triggers on_change() action. It's up to
// the GUI to check for option's limits, but we could receive the new value
// from the user by console window, so let's check the bounds anyway.
Option& Option::operator=(const string& v) {
assert(!type.empty());