docs: adding more Bibtex citations (#500)

Author: benthevining

docs/references.bib

@@ -7,3 +7,19 @@ @misc{Edwards_1994
     https://ia902908.us.archive.org/26/items/pgn-standard-1994-03-12/PGN_standard_1994-03-12.txt
   },
 }
+
+@misc{Meyer-Kahlen_2006,
+  author        = {Meyer-Kahlen, Stefan},
+  year          = 2006,
+  month         = apr,
+  journal       = {Description of the universal chess interface (UCI)},
+  url           = {https://www.shredderchess.com/download/div/uci.zip},
+}
+
+@book{Just_Burg_2003,
+  title         = {United States Chess Federation's Official Rules of Chess},
+  author        = {Just, Tim and Burg, Daniel B.},
+  year          = 2003,
+  publisher     = {Random House Puzzles \& Games},
+  edition       = 5,
+}

libchess/include/libchess/notation/ICCF.hpp

@@ -14,7 +14,7 @@
 
 /** @file
     This file provides functions for converting Move objects to and from
-    ICCF-format numeric notation.
+    ICCF-format @cite Just_Burg_2003 numeric notation.
 
     @ingroup notation
  */
@@ -35,14 +35,14 @@ namespace chess::notation {
 using game::Position;
 using moves::Move;
 
-/** Returns the ICCF-format algebraic notation for the given Move object.
+/** Returns the ICCF-format @cite Just_Burg_2003 notation for the given Move object.
 
     @ingroup notation
     @see from_iccf()
  */
 [[nodiscard]] auto to_iccf(Move move) -> std::string;
 
-/** Parses the ICCF-format algebraic notation string into a Move object.
+/** Parses the ICCF-format @cite Just_Burg_2003 notation string into a Move object.
     The current position is used to determine the type of the moved piece.
 
     If the input string cannot be parsed correctly, returns an explanatory error string.

libchess/include/libchess/notation/UCI.hpp

@@ -14,7 +14,7 @@
 
 /** @file
     This file provides functions for converting Move objects to and from
-    UCI-format algebraic notation.
+    UCI-format @cite Meyer-Kahlen_2006 algebraic notation.
 
     @ingroup notation
  */
@@ -35,14 +35,14 @@ namespace chess::notation {
 using game::Position;
 using moves::Move;
 
-/** Returns the UCI-format algebraic notation for the given Move object.
+/** Returns the UCI-format @cite Meyer-Kahlen_2006 algebraic notation for the given Move object.
 
     @ingroup notation
     @see from_uci()
  */
 [[nodiscard]] auto to_uci(Move move) -> std::string;
 
-/** Parses the UCI-format algebraic notation string into a Move object.
+/** Parses the UCI-format @cite Meyer-Kahlen_2006 algebraic notation string into a Move object.
     The current position is used to determine the type of the moved piece.
 
     If the input string cannot be parsed correctly, returns an explanatory error string.

libchess/include/libchess/uci/CommandParsing.hpp

@@ -13,13 +13,13 @@
  */
 
 /** @defgroup uci UCI
-    Utilities for working with the Universal Chess Interface.
+    Utilities for working with the Universal Chess Interface. @cite Meyer-Kahlen_2006
 
     @ingroup libchess
  */
 
 /** @file
-    This file provides utilities for parsing command-line UCI commands.
+    This file provides utilities for parsing command-line UCI @cite Meyer-Kahlen_2006 commands.
     @ingroup uci
  */
 
@@ -37,7 +37,7 @@ namespace chess::game {
 struct Position;
 } // namespace chess::game
 
-/** This namespace contains utilities for working with UCI.
+/** This namespace contains utilities for working with UCI. @cite Meyer-Kahlen_2006
     @ingroup uci
  */
 namespace chess::uci {
@@ -48,7 +48,7 @@ using std::optional;
 using std::size_t;
 using std::string_view;
 
-/** Parses the options following a UCI "position" command into a Position object.
+/** Parses the options following a UCI @cite Meyer-Kahlen_2006 "position" command into a Position object.
     The ``options`` should not include the "position" token itself.
 
     If the input string cannot be parsed correctly, returns an explanatory error string.
@@ -58,7 +58,7 @@ using std::string_view;
 [[nodiscard]] auto parse_position_options(string_view options)
     -> std::expected<Position, std::string>;
 
-/** This struct encapsulates the options to a UCI "register" command.
+/** This struct encapsulates the options to a UCI @cite Meyer-Kahlen_2006 "register" command.
 
     @ingroup uci
     @see parse_register_options()
@@ -76,15 +76,15 @@ struct RegisterNowOptions final {
  */
 using RegisterOptions = optional<RegisterNowOptions>;
 
-/** Parses the options following a UCI "register" command.
+/** Parses the options following a UCI @cite Meyer-Kahlen_2006 "register" command.
     The ``options`` should not include the "register" token itself.
     If this returns ``nullopt``, then the user sent a ``register later`` command.
 
     @ingroup uci
  */
 [[nodiscard]] auto parse_register_options(string_view options) -> RegisterOptions;
 
-/** This struct encapsulates the options given to a UCI "go" command.
+/** This struct encapsulates the options given to a UCI @cite Meyer-Kahlen_2006 "go" command.
 
     @ingroup uci
     @see parse_go_options()
@@ -129,7 +129,7 @@ struct [[nodiscard]] GoCommandOptions final {
     optional<size_t> mateIn;
 };
 
-/** Parses the options following a UCI "go" command.
+/** Parses the options following a UCI @cite Meyer-Kahlen_2006 "go" command.
     The ``options`` should not include the "go" token itself.
 
     @ingroup uci

libchess/include/libchess/uci/EngineBase.hpp

@@ -13,7 +13,7 @@
  */
 
 /** @file
-    This file defines the UCI engine base class.
+    This file defines the UCI @cite Meyer-Kahlen_2006 engine base class.
     @ingroup uci
  */
 
@@ -35,7 +35,7 @@ using std::string_view;
 
 struct Option;
 
-/** A base class for UCI chess engines.
+/** A base class for UCI @cite Meyer-Kahlen_2006 chess engines.
 
     This class provides handling of UCI command parsing, so that
     the engine implementation can focus purely on implementing

libchess/include/libchess/uci/Options.hpp

@@ -13,7 +13,7 @@
  */
 
 /** @file
-    This file provides classes for declaring UCI engine parameters.
+    This file provides classes for declaring UCI @cite Meyer-Kahlen_2006 engine parameters.
     @ingroup uci
  */
 
@@ -31,7 +31,7 @@ namespace chess::uci {
 using std::string;
 using std::string_view;
 
-/** Base class for UCI options.
+/** Base class for UCI @cite Meyer-Kahlen_2006 options.
 
     @ingroup uci
  */

libchess/include/libchess/uci/Printing.hpp

@@ -13,7 +13,7 @@
  */
 
 /** @file
-    This file provides some utility functions for printing UCI-style output.
+    This file provides some utility functions for printing UCI-style @cite Meyer-Kahlen_2006 output.
     @ingroup uci
  */
 
@@ -28,15 +28,15 @@
 #include <string_view>
 #include <variant>
 
-/** This namespace contains utility functions for printing UCI-style output.
+/** This namespace contains utility functions for printing UCI-style @cite Meyer-Kahlen_2006 output.
     @ingroup uci
  */
 namespace chess::uci::printing {
 
 using moves::Move;
 using std::size_t;
 
-/** Prints a UCI-formatted information string to standard output.
+/** Prints a UCI-formatted @cite Meyer-Kahlen_2006 information string to standard output.
     This function should be used for any informational or debug output that
     an engine wants to print.
 
@@ -47,7 +47,7 @@ using std::size_t;
  */
 std::monostate info_string(std::string_view info);
 
-/** Prints a UCI-formatted best move string to standard output.
+/** Prints a UCI-formatted @cite Meyer-Kahlen_2006 best move string to standard output.
     Specifying a ponder move is optional.
 
     @ingroup uci
@@ -129,7 +129,7 @@ struct SearchInfo final {
     [[nodiscard]] auto get_nps() const noexcept -> size_t;
 };
 
-/** Prints a UCI-formatted search info string to standard output.
+/** Prints a UCI-formatted @cite Meyer-Kahlen_2006 search info string to standard output.
 
     @ingroup uci
     @relates SearchInfo