Documented newBoard in Board.h

4 years ago · b81cba8d83
parent 319f0252de
commit b81cba8d83
1 changed files with 6 additions and 0 deletions
--- a/Pontu/include/model/Board.h
+++ b/Pontu/include/model/Board.h
@ -29,6 +29,12 @@ typedef struct {
 	const size_t nbPieces; ///< Logical size of arrPieces
 } Board;

+/**
+ * \brief Create a new board 
+ * 
+ * \param nbPlayers The number of players
+ * \return A new board for nbPlayers
+ */
 Board newBoard(const size_t nbPlayers);

 #endif // BOARD_H