Merge pull request #727 from FuelLabs/tictactoe-docs

tictactoe docs

games/TicTacToe/project/contracts/tictactoe-contract/src/data_structures.sw

@@ -2,8 +2,11 @@ library;
 
 use core::ops::Eq;
 
+/// Represents the state of a game.
 pub enum State {
+    /// The game is currently being played.
     Playing: (),
+    /// The game has ended.
     Ended: (),
 }
 

games/TicTacToe/project/contracts/tictactoe-contract/src/errors.sw

@@ -1,15 +1,23 @@
 library;
 
+/// Errors related to the state of the game.
 pub enum GameStateError {
+    /// The game has ended.
     GameHasEnded: (),
+    /// The game has not ended.
     GameHasNotEnded: (),
 }
 
+/// Errors made by players.
 pub enum PlayerError {
+    /// It is not the player's turn.
     IncorrectPlayerTurn: (),
 }
 
+/// Errors related to the position of a cell.
 pub enum PositionError {
+    /// The cell is occupied.
     CellIsNotEmpty: (),
+    /// The cell is out of bounds.
     InvalidPosition: (),
 }

games/TicTacToe/project/contracts/tictactoe-contract/src/events.sw

@@ -1,15 +1,23 @@
 library;
 
+/// Event for when a game results in a draw.
 pub struct GameDrawnEvent {
+    /// The first player.
     player_one: Identity,
+    /// The second player.
     player_two: Identity,
 }
 
+/// Event for when a game is won.
 pub struct GameWonEvent {
+    /// The winning player.
     player: Identity,
 }
 
+/// Event for when a new game is started.
 pub struct NewGameEvent {
+    /// The first player.
     player_one: Identity,
+    /// The second player.
     player_two: Identity,
 }

games/TicTacToe/project/contracts/tictactoe-contract/src/interface.sw

@@ -5,8 +5,8 @@ abi Game {
     ///
     /// # Arguments
     ///
-    /// * `player_one`: the first player to make a move.
-    /// * `player_two`: the second player to make a move.
+    /// * `player_one`: [Identity] - The first player to make a move.
+    /// * `player_two`: [Identity] - The second player to make a move.
     ///
     /// # Reverts
     ///
@@ -16,11 +16,13 @@ abi Game {
 
     /// Allows a player to make a move at a `position`.
     ///
+    /// # Additional Information
+    ///
     /// It also determines if the game has been won or drawn.
     ///
     /// # Arguments
     ///
-    /// * `position`: the position where the player wants to move.
+    /// * `position`: [u64] - The position where the player wants to move.
     ///
     /// # Reverts
     ///

games/TicTacToe/project/contracts/tictactoe-contract/src/utils.sw

@@ -13,6 +13,15 @@ const MATCHES = [
 ];
 
 /// Checks if a player has won.
+///
+/// # Arguments
+///
+/// * `board`: [Vec<Option<Identity>>] - A vector of all the markers on the board.
+/// * `player`: [Identity] - The player to check for.
+///
+/// # Returns
+///
+/// * [bool] - True if the player has won, false otherwise.
 pub fn win_check(board: Vec<Option<Identity>>, player: Identity) -> bool {
     let mut i = 0;
     while (i < 8) {
@@ -35,6 +44,17 @@ pub fn win_check(board: Vec<Option<Identity>>, player: Identity) -> bool {
 }
 
 /// Checks if the game ends up in a draw.
+///
+/// # Arguments
+///
+/// * `board`: [Vec<Option<Identity>>] - A vector of all the markers on the board.
+/// * `player_one`: [Identity] - The first player.
+/// * `player_two`: [Identity] - The second player.
+/// * `move_counter`: [u64] - The number of moves made.
+///
+/// # Returns
+///
+/// * [bool] - True if the game has ended in a draw, false otherwise.
 pub fn draw(
     board: Vec<Option<Identity>>,
     player_one: Identity,