add comments

include/game_interface.h

@@ -13,6 +13,9 @@
 namespace Hanabi
 {
 
+  /**
+   * A card together with an associated multiplicity
+   */
   struct CardMultiplicity
   {
     Card card;
@@ -32,7 +35,7 @@ namespace Hanabi
 
     virtual void rotate_next_draw(const Card & card) = 0;
 
-    virtual ActionType last_action_type() const = 0;
+    [[nodiscard]] virtual ActionType last_action_type() const = 0;
 
     virtual void revert() = 0;
 

include/hanabi_types.hpp

@@ -23,7 +23,7 @@ namespace Hanabi
 /**
  * Define macro
  * NUSE_RATIONAL_PROBABILITIES
- * to use floating-point arithematic for the stored probabilities
+ * to use floating-point arithmetic for the stored probabilities
  * instead of rational representations
 */
 

include/myassert.h

@@ -1,6 +1,15 @@
 #ifndef DYNAMIC_PROGRAM_MYASSERT_H
 #define DYNAMIC_PROGRAM_MYASSERT_H
 
+/**
+ * @file myassert.h
+ * This is essentially like the default assert header, but we additionally
+ * dummy-use the expression in case NDEBUG is defined.
+ * This ensures that we do not get compiler warnings for variables that are solely
+ * used in assertions.
+ * If there are such variables, they will be optimized out in opt-mode anyway.
+ */
+
 #ifdef NDEBUG
 #define ASSERT(x) do { (void)sizeof(x);} while (0)
 #else

include/null_buffer.h

@@ -13,6 +13,9 @@ namespace NullBuffer
     { return c; }
   };
 
+  /**
+   * A Stream that does nothing on writing to it
+   */
   class NullStream final : public std::ostream
   {
   public:

include/parse_game.h

@@ -36,7 +36,7 @@ namespace Parsing
   // Overload for parsing from json to HanabLiveAction
   HanabLiveAction tag_invoke(boost::json::value_to_tag<HanabLiveAction>, boost::json::value const & jv);
 
-  /*
+  /**
   * @brief Parse deck from hanab.live format
   * @return List of cards (in order) and number of suits
   */
@@ -48,6 +48,10 @@ namespace Parsing
    */
   std::vector<HanabLiveAction> parse_actions(const boost::json::value & action_json);
 
+  /**
+   * @brief Convert actions from hanab.live format.
+   * @return List of actions with concrete cards instead of their indices.
+   */
   std::vector<Hanabi::Action> convert_actions(
         std::vector<HanabLiveAction> const & hanab_live_actions, std::vector<Hanabi::Card> const & deck
   );

include/state_explorer.h

@@ -6,6 +6,10 @@
 
 namespace Hanabi
 {
+  /**
+   * Launches an interactive shell (on cout/cin) that allows to display, traverse and modify
+   * the given game state.
+   */
   void cli(Game const & game);
 }