From a99c21809f70dd64ba75287ff0411e3ea082e9c7 Mon Sep 17 00:00:00 2001 From: Alex Pearwin Date: Mon, 30 Oct 2023 00:45:47 +0000 Subject: [PATCH] Checkpoint. --- lib/twenty_forty_eight/game/board.ex | 3 +++ lib/twenty_forty_eight/game/engine.ex | 3 +++ lib/twenty_forty_eight/game/game.ex | 3 +++ lib/twenty_forty_eight/game/manager.ex | 3 +++ lib/twenty_forty_eight/mailer.ex | 1 + lib/twenty_forty_eight_web/components/core_components.ex | 2 +- lib/twenty_forty_eight_web/components/layouts.ex | 1 + lib/twenty_forty_eight_web/telemetry.ex | 1 + 8 files changed, 16 insertions(+), 1 deletion(-) diff --git a/lib/twenty_forty_eight/game/board.ex b/lib/twenty_forty_eight/game/board.ex index 8515c48..1d95bed 100644 --- a/lib/twenty_forty_eight/game/board.ex +++ b/lib/twenty_forty_eight/game/board.ex @@ -1,4 +1,7 @@ defmodule TwentyFortyEight.Game.Board do + @moduledoc """ + Game board value store and business logic handler. + """ @enforce_keys [:cells, :num_rows, :num_cols] defstruct [:cells, :num_rows, :num_cols] diff --git a/lib/twenty_forty_eight/game/engine.ex b/lib/twenty_forty_eight/game/engine.ex index 15bdef3..0aa5d1f 100644 --- a/lib/twenty_forty_eight/game/engine.ex +++ b/lib/twenty_forty_eight/game/engine.ex @@ -1,4 +1,7 @@ defmodule TwentyFortyEight.Game.Engine do + @moduledoc """ + Mutate game state via input events. + """ alias TwentyFortyEight.Game.Board @doc """ diff --git a/lib/twenty_forty_eight/game/game.ex b/lib/twenty_forty_eight/game/game.ex index aee713e..c67f0d1 100644 --- a/lib/twenty_forty_eight/game/game.ex +++ b/lib/twenty_forty_eight/game/game.ex @@ -1,4 +1,7 @@ defmodule TwentyFortyEight.Game.Game do + @moduledoc """ + Persistance layer for storing game state to a database. + """ use Ecto.Schema import Ecto.Changeset diff --git a/lib/twenty_forty_eight/game/manager.ex b/lib/twenty_forty_eight/game/manager.ex index f7771b2..3281961 100644 --- a/lib/twenty_forty_eight/game/manager.ex +++ b/lib/twenty_forty_eight/game/manager.ex @@ -1,4 +1,7 @@ defmodule TwentyFortyEight.Game.Manager do + @moduledoc """ + Store game state and process business logic events. + """ use GenServer, restart: :transient alias TwentyFortyEight.Game.{Board, Engine, Game} diff --git a/lib/twenty_forty_eight/mailer.ex b/lib/twenty_forty_eight/mailer.ex index 136bda4..316a790 100644 --- a/lib/twenty_forty_eight/mailer.ex +++ b/lib/twenty_forty_eight/mailer.ex @@ -1,3 +1,4 @@ defmodule TwentyFortyEight.Mailer do + @moduledoc false use Swoosh.Mailer, otp_app: :twenty_forty_eight end diff --git a/lib/twenty_forty_eight_web/components/core_components.ex b/lib/twenty_forty_eight_web/components/core_components.ex index 152fd4f..a47bdc4 100644 --- a/lib/twenty_forty_eight_web/components/core_components.ex +++ b/lib/twenty_forty_eight_web/components/core_components.ex @@ -230,7 +230,7 @@ defmodule TwentyFortyEightWeb.CoreComponents do