added docs

Author: bitgamma

.gitignore

@@ -1,6 +1,7 @@
 _build
 deps
 priv
+doc
 CMakeFiles
 CMakeCache.txt
 cmake_install.cmake

lib/serial.ex

@@ -1,4 +1,8 @@
 defmodule Serial do
+  @moduledoc """
+  Serial communication through Elixir ports.
+  """
+
   use GenServer
 
   @send 0
@@ -11,51 +15,82 @@ defmodule Serial do
   @parity_even 7
   @break 8
 
-  def start_link(pid) do
-    GenServer.start_link(__MODULE__, pid)
+  @doc """
+  Starts a serial port. The process invoking this function will receive
+  messages in the form of `{:elixir_serial, pid, data}`.
+  """
+  def start_link(opts \\ []) do
+    GenServer.start_link(__MODULE__, self(), opts)
   end
 
+  @doc """
+  Opens a connection to the given tty.
+  """
   def open(pid, tty) do
     GenServer.call(pid, {:open, tty})
   end
 
+  @doc """
+  Close the currently open connection.
+  """
   def close(pid) do
     GenServer.call(pid, {:cmd, @close})
   end
 
+  @doc """
+  Reopens the connection to the current tty.
+  """
   def connect(pid) do
     GenServer.call(pid, {:cmd, @connect})
   end
 
+  @doc """
+  Disconnects from the current tty.
+  """
   def disconnect(pid) do
     GenServer.call(pid, {:cmd, @disconnect})
   end
 
+  @doc """
+  Sets the connection speed to the given value.
+  """
   def set_speed(pid, speed) do
     set_speed(pid, speed, speed)
   end
 
+  @doc """
+  Sets the input and output connection speed to the given values.
+  """
   def set_speed(pid, in_speed, out_speed) do
     GenServer.call(pid, {:speed, in_speed, out_speed})
   end
 
+  @doc """
+  Sets the parity to either `:odd` and `:even`.
+  """
   def set_parity(pid, :odd) do
     GenServer.call(pid, {:cmd, @parity_odd})
   end
   def set_parity(pid, :even) do
     GenServer.call(pid, {:cmd, @parity_even})
   end
 
+  @doc """
+  Sends a break to the open connection.
+  """
   def break(pid) do
     GenServer.call(pid, {:cmd, @break})
   end
 
+  @doc """
+  Sends data over the open connection.
+  """
   def send_data(pid, data) do
     GenServer.call(pid, {:send, data})
   end
 
   def init(pid) do
-    exec = :code.priv_dir(:elixir_serial) ++ '/serial'
+    exec = :code.priv_dir(:serial) ++ '/serial'
     port = Port.open({:spawn_executable, exec}, [{:args, ['-erlang']}, :binary, {:packet, 2}])
     {:ok, {pid, port}}
   end

mix.exs

@@ -18,26 +18,32 @@ defmodule Serial.Mixfile do
      compilers: [:cmake] ++ Mix.compilers,
      build_embedded: Mix.env == :prod,
      start_permanent: Mix.env == :prod,
-     deps: deps]
+     deps: deps,
+     package: package,
+     description: description,
+     docs: [readme: "README.md", main: "README"]]
   end
 
-  # Configuration for the OTP application
-  #
-  # Type `mix help compile.app` for more information
   def application do
     [applications: [:logger]]
   end
 
-  # Dependencies can be Hex packages:
-  #
-  #   {:mydep, "~> 0.3.0"}
-  #
-  # Or git/path repositories:
-  #
-  #   {:mydep, git: "https://github.com/elixir-lang/mydep.git", tag: "0.1.0"}
-  #
-  # Type `mix help deps` for more examples and options
   defp deps do
-    []
+    [
+      {:earmark, "~> 0.1", only: :docs},
+      {:ex_doc, "~> 0.8", only: :docs}
+    ]
+  end
+
+  defp description do
+    "Serial communication through Elixir ports"
+  end
+
+  defp package do
+    [
+      contributors: ["Michele Balistreri"],
+      licenses: ["ISC"],
+      links: %{"GitHub" => "https://github.com/bitgamma/elixir_serial"}
+    ]
   end
 end