Add doxygen comments to files

m-heim · Feb 19, 2024 · bb6fbc2 · bb6fbc2
1 parent 2e65a78
commit bb6fbc2
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/src/position/fen.cpp b/src/position/fen.cpp
@@ -6,6 +6,9 @@
 #include <iostream>
 #include <square.hpp>
 
+/*
+ @brief Parse a fen from a string, exits on error
+*/
 Position parseFen(const std::string &fen) {
     int start = 0;
     size_t next = fen.find(' ', start);
@@ -86,6 +89,9 @@ Position parseFen(const std::string &fen) {
     return position;
 }
 
+/*
+ @brief read a fen from a file, does not check for validity
+*/
 std::string readFen(const std::string &fenPath) {
     std::ifstream fen_file_stream(fenPath, std::ios::in);
     if (!fen_file_stream.is_open()) {

diff --git a/src/position/zobrist.hpp b/src/position/zobrist.hpp
@@ -3,11 +3,17 @@
 #include <bitboard.hpp>
 #include <chess.hpp>
 
+/*
+ @link https://www.chessprogramming.org/Zobrist_Hashing
+ @brief Allows to hash a position into a 64 Bit number for transposition purposes
+ */
+
 constexpr Bitboard ZOBRIST_SEED = fileA | fileH | rank4;
 
 extern std::array<std::array<std::array<Bitboard, Square::SQUARE_COUNT>, Piece::KING + 1>,
                   Color::BLACK + 1>
     zobristKeys;
+
 extern Bitboard zobristSide;
 extern std::array<Bitboard, File::FILE_COUNT> zobristEnPassant;
 extern std::array<std::array<std::array<Bitboard, 2>, Castle::CASTLE_COUNT>, Color::BLACK + 1>