Hide docs for some internal modules

Nebo15 · May 14, 2024 · 44e76af · 44e76af
1 parent 1845d5d
commit 44e76af
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 0 deletions.
diff --git a/lib/logger_json/formatter/code.ex b/lib/logger_json/formatter/code.ex
@@ -1,4 +1,6 @@
 defmodule LoggerJSON.Formatter.Code do
+  @moduledoc false
+
   @doc """
   Provide a string output of the MFA log entry.
   """

diff --git a/lib/logger_json/formatter/datetime.ex b/lib/logger_json/formatter/datetime.ex
@@ -1,4 +1,6 @@
 defmodule LoggerJSON.Formatter.DateTime do
+  @moduledoc false
+
   @doc """
   Returns either a `time` taken from metadata or current time in RFC3339 UTC "Zulu" format.
   """

diff --git a/lib/logger_json/formatter/map_builder.ex b/lib/logger_json/formatter/map_builder.ex
@@ -1,4 +1,6 @@
 defmodule LoggerJSON.Formatter.MapBuilder do
+  @moduledoc false
+
   @doc """
   Optionally put a value to a map.
   """

diff --git a/lib/logger_json/formatter/message.ex b/lib/logger_json/formatter/message.ex
@@ -1,4 +1,6 @@
 defmodule LoggerJSON.Formatter.Message do
+  @moduledoc false
+
   # crash
   def format_message({:string, message}, %{crash_reason: crash_reason}, %{crash: crash_fmt}) do
     crash_fmt.(message, crash_reason)

diff --git a/lib/logger_json/formatter/metadata.ex b/lib/logger_json/formatter/metadata.ex
@@ -1,4 +1,6 @@
 defmodule LoggerJSON.Formatter.Metadata do
+  @moduledoc false
+
   @ignored_metadata_keys ~w[ansi_color initial_call crash_reason pid gl mfa report_cb time]a
 
   @doc """

diff --git a/lib/logger_json/formatter/plug.ex b/lib/logger_json/formatter/plug.ex
@@ -1,5 +1,7 @@
 if Code.ensure_loaded?(Plug) do
   defmodule LoggerJSON.Formatter.Plug do
+    @moduledoc false
+
     alias Plug.Conn
 
     @doc """