Add basic module doc string

dainst · Aug 6, 2024 · 911ca98 · 911ca98
1 parent 8399b30
commit 911ca98
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/publication/lib/field_publication_web/user_auth.ex b/publication/lib/field_publication_web/user_auth.ex
@@ -9,6 +9,12 @@ defmodule FieldPublicationWeb.UserAuth do
   import Plug.Conn
   import Phoenix.Controller
 
+  @moduledoc """
+  This module implements plugs for handling user authentication and the different authorization levels.
+
+  See also the official [Phoenix documentation](https://hexdocs.pm/phoenix/plug.html).
+  """
+
   defmodule Token do
     @enforce_keys [:name, :token, :context]
     defstruct [:name, :token, :context]