Skip to content

Commit

Permalink
add @moduledoc tag comment to all newly created files and some old on…
Browse files Browse the repository at this point in the history
  • Loading branch information
nelsonic committed Aug 20, 2020
1 parent 812e192 commit 5a0d8bf
Show file tree
Hide file tree
Showing 10 changed files with 30 additions and 0 deletions.
3 changes: 3 additions & 0 deletions lib/auth/apikey.ex
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions lib/auth/login_log.ex
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions lib/auth/people_roles.ex
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions lib/auth/permission.ex
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions lib/auth/person.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
defmodule Auth.Person do
@moduledoc """
Defines Person schema and CRUD functions
"""
use Ecto.Schema
import Ecto.Changeset
alias Auth.Repo
Expand Down
3 changes: 3 additions & 0 deletions lib/auth/role.ex
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions lib/auth_web/controllers/apikey_controller.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
defmodule AuthWeb.ApikeyController do
@moduledoc """
Defines API Key controller functions
"""
use AuthWeb, :controller
alias Auth.Apikey

Expand Down
3 changes: 3 additions & 0 deletions lib/auth_web/controllers/auth_controller.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
defmodule AuthWeb.AuthController do
@moduledoc """
Defines AuthController and all functions for authenticaiton
"""
use AuthWeb, :controller
alias Auth.Person

Expand Down
3 changes: 3 additions & 0 deletions lib/auth_web/router.ex
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
defmodule AuthWeb.Router do
@moduledoc """
Defines Web Application Router pipelines and routes
"""
use AuthWeb, :router

pipeline :browser do
Expand Down
3 changes: 3 additions & 0 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
defmodule Auth.Mixfile do
@moduledoc """
Defines the Mix Project, Dependencies and Scripts
"""
use Mix.Project

def project do
Expand Down

0 comments on commit 5a0d8bf

Please sign in to comment.