Skip to content

Commit 126fd06

Browse files
committed
docs: basic docs
1 parent 608cc84 commit 126fd06

File tree

5 files changed

+13
-21
lines changed

5 files changed

+13
-21
lines changed

lib/web_dev_utils.ex

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
11
defmodule WebDevUtils do
2-
@moduledoc """
3-
Documentation for `WebDevUtils`.
4-
"""
5-
6-
@doc """
7-
Hello world.
8-
9-
## Examples
10-
11-
iex> WebDevUtils.hello()
12-
:world
13-
14-
"""
15-
def hello do
16-
:world
17-
end
2+
@moduledoc false
183
end

lib/web_dev_utils/assets.ex

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# module mostly taken from `Phoenix.Endpoint.Watcher`
2-
# copyright belongs to them.
32

43
defmodule WebDevUtils.Assets do
5-
@moduledoc false
4+
@moduledoc """
5+
Task for starting arbitrary commands and Elixir modules (like `Tailwind` and `Esbuild`).
6+
"""
67
require Logger
78

89
def child_spec(args) do

lib/web_dev_utils/code_reloader.ex

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
defmodule WebDevUtils.CodeReloader do
2-
@moduledoc false
2+
@moduledoc """
3+
The code reloader process.
4+
"""
35

46
# Handles automatic code reloading.
57

lib/web_dev_utils/filesystem.ex

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
defmodule WebDevUtils.FileSystem do
2-
@moduledoc false
2+
@moduledoc """
3+
The file watcher process.
4+
"""
35
def child_spec(_) do
46
%{
57
id: FileSystem,

lib/web_dev_utils/live_reload.ex

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
defmodule WebDevUtils.LiveReload do
2-
@moduledoc false
2+
@moduledoc """
3+
Notifications (usually sent to a web browser) when files on disk change.
4+
"""
35
require Logger
46

57
def init(opts \\ []) do

0 commit comments

Comments
 (0)