fixed mismatches between docstring and function variable names following renaming

Author: Hardcode3

include/bitbishop/bitboard.hpp

@@ -375,7 +375,7 @@ class Bitboard {
    public:
     /**
      * @brief Constructs an iterator for a given bit pattern.
-     * @param b The 64-bit bitboard value to iterate over.
+     * @param bitboard The 64-bit bitboard value to iterate over.
      */
     constexpr Iterator(uint64_t bitboard) noexcept : bits(bitboard) {}
 

include/bitbishop/board.hpp

@@ -65,21 +65,21 @@ class Board {
 
   /**
    * @brief Retrieves the piece on a given square.
-   * @param sq The square to query.
+   * @param square The square to query.
    * @return Piece located on `sq' or std::nullopt if no piece lays on that square.
    */
   [[nodiscard]] std::optional<Piece> get_piece(Square square) const;
 
   /**
    * @brief (Re)Places a piece on a given square.
-   * @param sq The square where the piece will be placed.
-   * @param p The piece type (including color).
+   * @param square The square where the piece will be placed.
+   * @param piece The piece type (including color).
    */
   void set_piece(Square square, Piece piece);
 
   /**
    * @brief Removes any piece from a given square.
-   * @param sq The square to clear.
+   * @param square The square to clear.
    */
   void remove_piece(Square square);
 

include/bitbishop/lookups/bishop.hpp

@@ -9,7 +9,7 @@ namespace Lookups {
 
 /**
  * @brief Generates a bitboard of all squares a bishop can attack moving northeast from the given square.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a bishop moving northeast.
  */
 constexpr uint64_t bishop_northeast_attacks(int square) {
@@ -28,7 +28,7 @@ constexpr uint64_t bishop_northeast_attacks(int square) {
 
 /**
  * @brief Generates a bitboard of all squares a bishop can attack moving northwest from the given square.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a bishop moving northwest.
  */
 constexpr uint64_t bishop_northwest_attacks(int square) {
@@ -47,7 +47,7 @@ constexpr uint64_t bishop_northwest_attacks(int square) {
 
 /**
  * @brief Generates a bitboard of all squares a bishop can attack moving southeast from the given square.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a bishop moving southeast.
  */
 constexpr uint64_t bishop_southeast_attacks(int square) {
@@ -66,7 +66,7 @@ constexpr uint64_t bishop_southeast_attacks(int square) {
 
 /**
  * @brief Generates a bitboard of all squares a bishop can attack moving southwest from the given square.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a bishop moving southwest.
  */
 constexpr uint64_t bishop_southwest_attacks(int square) {
@@ -85,7 +85,7 @@ constexpr uint64_t bishop_southwest_attacks(int square) {
 
 /**
  * @brief Generates a bitboard of all squares a bishop can attack from the given square in all directions.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a bishop from the given square.
  */
 constexpr uint64_t bishop_attacks_for_square(int square) {

include/bitbishop/lookups/king.hpp

@@ -12,7 +12,7 @@ namespace Lookups {
  * Given a square index (0-63), returns a bitboard with all squares attacked by a king from that square.
  * Takes into account board edges to avoid wrap-around attacks.
  *
- * @param sq The square index (0 = a1, 63 = h8).
+ * @param square The square index (0 = a1, 63 = h8).
  * @return Bitboard representing all possible king attacks from the given square.
  */
 constexpr uint64_t king_attacks_for_square(int square) {

include/bitbishop/lookups/knight.hpp

@@ -12,7 +12,7 @@ namespace Lookups {
  * Given a square index (0-63), returns a bitboard with all squares attacked by a knight from that square.
  * Takes into account board edges to avoid wrap-around attacks.
  *
- * @param sq The square index (0 = a1, 63 = h8).
+ * @param square The square index (0 = a1, 63 = h8).
  * @return Bitboard representing all possible knight attacks from the given square.
  */
 constexpr uint64_t knight_attacks_for_square(int square) {

include/bitbishop/lookups/queen.hpp

@@ -11,7 +11,7 @@ namespace Lookups {
 
 /**
  * @brief Generates a bitboard of all squares a queen can attack from the given square in all directions.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a queen from the given square.
  *
  * Note that queen moves is the combination of rook and bishop moves.

include/bitbishop/lookups/rook.hpp

@@ -9,7 +9,7 @@ namespace Lookups {
 
 /**
  * @brief Generates a bitboard of all squares a rook can attack moving north from the given square.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a rook moving north.
  */
 constexpr uint64_t rook_north_attacks(int square) {
@@ -26,7 +26,7 @@ constexpr uint64_t rook_north_attacks(int square) {
 
 /**
  * @brief Generates a bitboard of all squares a rook can attack moving south from the given square.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a rook moving south.
  */
 constexpr uint64_t rook_south_attacks(int square) {
@@ -43,7 +43,7 @@ constexpr uint64_t rook_south_attacks(int square) {
 
 /**
  * @brief Generates a bitboard of all squares a rook can attack moving east from the given square.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a rook moving east.
  */
 constexpr uint64_t rook_east_attacks(int square) {
@@ -60,7 +60,7 @@ constexpr uint64_t rook_east_attacks(int square) {
 
 /**
  * @brief Generates a bitboard of all squares a rook can attack moving west from the given square.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a rook moving west.
  */
 constexpr uint64_t rook_west_attacks(int square) {
@@ -77,7 +77,7 @@ constexpr uint64_t rook_west_attacks(int square) {
 
 /**
  * @brief Generates a bitboard of all squares a rook can attack from the given square in all directions.
- * @param sq The square index (0-63).
+ * @param square The square index (0-63).
  * @return Bitboard of all squares attacked by a rook from the given square.
  */
 constexpr uint64_t rook_attacks_for_square(int square) {

include/bitbishop/moves/pawn_move_gen.hpp

@@ -68,8 +68,8 @@ void add_pawn_promotions(std::vector<Move>& moves, Square from, Square to, Color
  * Pawns start on rank 2 (index 1) for White and rank 7 (index 6) for Black.
  * This is used to determine if a pawn is eligible to perform a double push.
  *
- * @param sq Square to check
- * @param c Color of the pawn
+ * @param square Square to check
+ * @param color Color of the pawn
  * @return true if the square is on the starting rank for the given color, false otherwise
  */
 constexpr bool is_starting_rank(Square square, Color color) {
@@ -82,8 +82,8 @@ constexpr bool is_starting_rank(Square square, Color color) {
  *
  * Pawns promote when reaching rank 8 (index 7) for White or rank 1 (index 0) for Black.
  *
- * @param sq Square to check
- * @param c Color of the pawn
+ * @param square Square to check
+ * @param color Color of the pawn
  * @return true if the square is on the promotion rank for the given color, false otherwise
  */
 constexpr bool is_promotion_rank(Square square, Color color) {