adding docs to all functions

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