aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteven Blowers <shdblowers@gmail.com>2016-10-30 19:13:26 (GMT)
committerSteven Blowers <shdblowers@gmail.com>2016-10-30 19:13:26 (GMT)
commit6d74d6100c59d6b0d8b2316333b3811c7c0ae26d (patch)
tree6d16be1c4de5cab02700458d79f26f5ccac86a27
parent663ef07a2768e0686108af88be949cc8b72110e2 (diff)
downloadzendex-6d74d6100c59d6b0d8b2316333b3811c7c0ae26d.tar.gz
zendex-6d74d6100c59d6b0d8b2316333b3811c7c0ae26d.tar.xz
adding docs to all functions
-rw-r--r--lib/zendex/search.ex3
-rw-r--r--lib/zendex/ticket.ex6
2 files changed, 9 insertions, 0 deletions
diff --git a/lib/zendex/search.ex b/lib/zendex/search.ex
index 95c0a69..ec9ea28 100644
--- a/lib/zendex/search.ex
+++ b/lib/zendex/search.ex
@@ -8,6 +8,9 @@ defmodule Zendex.Search do
@url "/api/v2/search.json?query="
@http_client Application.get_env(:zendex, :http_client)
+ @doc """
+ Search Zendesk.
+ """
@spec query(Zendex.Connection.t, map, String.t, String.t) :: map
def query(connection, query, sort_by \\ "", sort_order \\ "desc") do
diff --git a/lib/zendex/ticket.ex b/lib/zendex/ticket.ex
index 3be6789..8a7fd8a 100644
--- a/lib/zendex/ticket.ex
+++ b/lib/zendex/ticket.ex
@@ -9,6 +9,9 @@ defmodule Zendex.Ticket do
@url "/api/v2/tickets.json"
@http_client Application.get_env(:zendex, :http_client)
+ @doc """
+ List all tickets.
+ """
@spec list(Zendex.Connection.t) :: map
def list(connection) do
connection.base_url
@@ -17,6 +20,9 @@ defmodule Zendex.Ticket do
|> CommonHelpers.decode_response
end
+ @doc """
+ Create a new ticket.
+ """
@spec create(Zendex.Connection.t, map) :: map
def create(connection, ticket) do
connection.base_url