diff --git a/lib/auth/apikey.ex b/lib/auth/apikey.ex index c45d6c6d..4c087636 100644 --- a/lib/auth/apikey.ex +++ b/lib/auth/apikey.ex @@ -1,4 +1,7 @@ defmodule Auth.Apikey do + @moduledoc """ + Defines apikeys schema and CRUD functions + """ use Ecto.Schema import Ecto.Query, warn: false import Ecto.Changeset diff --git a/lib/auth/login_log.ex b/lib/auth/login_log.ex index cf9eca1a..bc13bb13 100644 --- a/lib/auth/login_log.ex +++ b/lib/auth/login_log.ex @@ -1,4 +1,7 @@ defmodule Auth.LoginLog do + @moduledoc """ + Defines login_logs schema and CRUD functions + """ use Ecto.Schema import Ecto.Changeset alias Auth.Repo diff --git a/lib/auth/people_roles.ex b/lib/auth/people_roles.ex index 2bacfd38..ef1141e3 100644 --- a/lib/auth/people_roles.ex +++ b/lib/auth/people_roles.ex @@ -1,4 +1,7 @@ defmodule Auth.PeopleRoles do + @moduledoc """ + Defines people_roles schema and fuction to grant roles to a person. + """ use Ecto.Schema import Ecto.Changeset alias Auth.Repo diff --git a/lib/auth/permission.ex b/lib/auth/permission.ex index a26b031d..9ef99ef7 100644 --- a/lib/auth/permission.ex +++ b/lib/auth/permission.ex @@ -1,4 +1,7 @@ defmodule Auth.Permission do + @moduledoc """ + Defines Rermission schema and CRUD functions + """ use Ecto.Schema import Ecto.Changeset import Ecto.Query, warn: false diff --git a/lib/auth/person.ex b/lib/auth/person.ex index b4dedcdd..002f5bba 100644 --- a/lib/auth/person.ex +++ b/lib/auth/person.ex @@ -1,4 +1,7 @@ defmodule Auth.Person do + @moduledoc """ + Defines Person schema and CRUD functions + """ use Ecto.Schema import Ecto.Changeset alias Auth.Repo diff --git a/lib/auth/role.ex b/lib/auth/role.ex index 887577dc..5f08b82a 100644 --- a/lib/auth/role.ex +++ b/lib/auth/role.ex @@ -1,4 +1,7 @@ defmodule Auth.Role do + @moduledoc """ + Defines Role schema and CRUD functions + """ use Ecto.Schema import Ecto.Changeset import Ecto.Query, warn: false diff --git a/lib/auth_web/controllers/apikey_controller.ex b/lib/auth_web/controllers/apikey_controller.ex index efb9eeb0..dc3972fb 100644 --- a/lib/auth_web/controllers/apikey_controller.ex +++ b/lib/auth_web/controllers/apikey_controller.ex @@ -1,4 +1,7 @@ defmodule AuthWeb.ApikeyController do + @moduledoc """ + Defines API Key controller functions + """ use AuthWeb, :controller alias Auth.Apikey diff --git a/lib/auth_web/controllers/auth_controller.ex b/lib/auth_web/controllers/auth_controller.ex index be83887e..50eedbd1 100644 --- a/lib/auth_web/controllers/auth_controller.ex +++ b/lib/auth_web/controllers/auth_controller.ex @@ -1,4 +1,7 @@ defmodule AuthWeb.AuthController do + @moduledoc """ + Defines AuthController and all functions for authenticaiton + """ use AuthWeb, :controller alias Auth.Person diff --git a/lib/auth_web/router.ex b/lib/auth_web/router.ex index e16949c8..7e798df6 100644 --- a/lib/auth_web/router.ex +++ b/lib/auth_web/router.ex @@ -1,4 +1,7 @@ defmodule AuthWeb.Router do + @moduledoc """ + Defines Web Application Router pipelines and routes + """ use AuthWeb, :router pipeline :browser do diff --git a/mix.exs b/mix.exs index 3e32b768..aef11f5c 100644 --- a/mix.exs +++ b/mix.exs @@ -1,4 +1,7 @@ defmodule Auth.Mixfile do + @moduledoc """ + Defines the Mix Project, Dependencies and Scripts + """ use Mix.Project def project do