Remove docs various modules

This commit is contained in:
Wout De Puysseleir 2023-03-25 23:10:58 -07:00
parent efa3f8f72d
commit af433e63a9
No known key found for this signature in database
GPG key ID: 3DE9371B50FEC46A
3 changed files with 18 additions and 18 deletions

View file

@ -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

View file

@ -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 %>

View file

@ -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)