Add some @spec

Betree · Jul 27, 2018 · 5f0062a · 5f0062a
1 parent 16d67b2
commit 5f0062a
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/lib/atomex.ex b/lib/atomex.ex
@@ -11,10 +11,12 @@ defmodule Atomex do
 
     - feed: an `Atomex.Feed`
   """
+  @spec generate_document(Atomex.Feed.t()) :: binary()
   def generate_document(feed) do
     XmlBuilder.doc(feed)
   end
 
+  @spec version() :: binary()
   def version do
     elem(:application.get_key(:atomex, :vsn), 1)
   end

diff --git a/lib/atomex/entry.ex b/lib/atomex/entry.ex
@@ -3,6 +3,8 @@ defmodule Atomex.Entry do
   A feed entry
   """
 
+  @type t :: list()
+
   import XmlBuilder
   alias Atomex.Types.{Person, Link, Text, Content, Category}
 

diff --git a/lib/atomex/feed.ex b/lib/atomex/feed.ex
@@ -3,12 +3,15 @@ defmodule Atomex.Feed do
   Represent an Atom feed. Embed many `Atomex.Entry`
   """
 
+  @type t :: list()
+
   import XmlBuilder
   alias Atomex.Types.{Person, Link, Text, Category}
 
   @doc """
   Create a new feed
   """
+  @spec new(binary(), DateTime.t, binary(), binary()) :: Atomex.Feed.t
   def new(id, last_update_datetime, title, title_type \\ "text") do
     [
       {:id, nil, id},
@@ -55,18 +58,21 @@ defmodule Atomex.Feed do
   @doc """
   Add an author to the feed. See `Atomex.Types.Person` for accepted attributes
   """
+  @spec author(Atomex.Feed.t, binary(), list()) :: Atomex.Feed.t
   def author(feed, name, attributes \\ []),
     do: add_field(feed, Person.new(:author, name, attributes))
 
   @doc """
   Add a link to the feed. See `Atomex.Types.Link` for accepted attributes
   """
+  @spec link(Atomex.Feed.t, binary(), list()) :: Atomex.Feed.t
   def link(feed, href, attributes \\ []),
     do: add_field(feed, Link.new(href, attributes))
 
   @doc """
   Add given entries to the feed
   """
+  @spec entries(Atomex.Feed.t, list(Atomex.Entry.t)) :: Atomex.Feed.t
   def entries(feed, entries),
     do: feed ++ entries