Fehlendes Doxygen

liblvl/src/include/player.hpp

@@ -7,15 +7,43 @@
 namespace lvl
 {
 
+/**
+ * @brief Starting Values and Sprite IDs for the Player
+ */
 class Player
 {
   public:
+    /**
+     * @brief Create a Player with default values. Useful when no HDF5 File is available.
+     */
     Player();
+
+    /**
+     * @brief Create a Player with given values.
+     * @param health Starting Health of the Player
+     * @param sprites IDs of Player sprites in the Tilesheet.
+     * @param bullets IDs of the Players bullets in the Tilesheet.
+     */
     Player(int health, const std::vector<int> &sprites, const std::vector<int> &bullets);
+
     ~Player() = default;
 
+    /**
+     * @brief Get the Players starting health.
+     * @return The players starting health.
+     */
     int getHealth() const;
+
+    /**
+     * @brief Get the Players sprite ids.
+     * @return The players sprite ids.
+     */
     const std::vector<int> &getSprites() const;
+
+    /**
+     * @brief Get the Bullet sprite ids.
+     * @return The bullet sprite ids.
+     */
     const std::vector<int> &getBullets() const;
 
   private: