From af433e63a9d20c8a2c8c3fefb522e87cb36e9e80 Mon Sep 17 00:00:00 2001 From: Wout De Puysseleir Date: Sat, 25 Mar 2023 23:10:58 -0700 Subject: [PATCH] Remove docs various modules --- lib/logger.ex | 20 +++++--------------- lib/slots.ex | 11 ++++++++--- lib/ssr.ex | 5 +++++ 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/lib/logger.ex b/lib/logger.ex index f5e8f4d..9702b5e 100644 --- a/lib/logger.ex +++ b/lib/logger.ex @@ -1,25 +1,15 @@ defmodule LiveSvelte.Logger do - @moduledoc """ - Helper function for logging messages to the shell - """ + @moduledoc false - @doc """ - Logs info messages to the shell - """ + @doc false def log_info(status), do: Mix.shell().info([status, :reset]) - @doc """ - Logs success messages to the shell - """ + @doc false def log_success(status), do: Mix.shell().info([:green, status, :reset]) - @doc """ - Logs warning messages to the shell - """ + @doc false def log_warning(status), do: Mix.shell().info([:yellow, status, :reset]) - @doc """ - Logs error messages to the shell - """ + @doc false def log_error(status), do: Mix.shell().error([status, :reset]) end diff --git a/lib/slots.ex b/lib/slots.ex index a48a19f..1bc295d 100644 --- a/lib/slots.ex +++ b/lib/slots.ex @@ -1,15 +1,16 @@ defmodule LiveSvelte.Slots do + @moduledoc false + import Phoenix.Component + @doc false def rendered_slot_map(assigns) do assigns |> filter_slots_from_assigns() |> render_slots() end - @doc """ - Processes the slots for use in JavaScript. - """ + @doc false def js_process(assigns) do assigns |> Enum.map(fn @@ -19,12 +20,14 @@ defmodule LiveSvelte.Slots do |> Enum.into(%{}) end + @doc false def base_encode_64(assigns) do assigns |> Enum.map(fn {key, value} -> {key, Base.encode64(value)} end) |> Enum.into(%{}) end + @doc false defp filter_slots_from_assigns(assigns) do assigns |> Enum.filter(fn @@ -34,12 +37,14 @@ defmodule LiveSvelte.Slots do |> Enum.into(%{}) end + @doc false defp render_slots(assigns) do Enum.reduce(assigns, %{}, fn {key, value}, acc -> Map.put(acc, key, render(%{slot: value})) end) end + @doc false defp render(assigns) do ~H""" <%= if assigns[:slot] do %> diff --git a/lib/ssr.ex b/lib/ssr.ex index 2b51be5..62ea583 100644 --- a/lib/ssr.ex +++ b/lib/ssr.ex @@ -1,4 +1,6 @@ defmodule LiveSvelte.SSR.NodeNotConfigured do + @moduledoc false + defexception message: """ NodeJS is not configured. Please add the following to your application.ex: {NodeJS.Supervisor, [path: "#{File.cwd!()}/assets", pool_size: 4]}, @@ -6,6 +8,9 @@ defmodule LiveSvelte.SSR.NodeNotConfigured do end defmodule LiveSvelte.SSR do + @moduledoc false + + @doc false def render(name, props, slots \\ nil) def render(name, nil, slots), do: render(name, %{}, slots)