From 9fe8c492962499d02085ed5b5e4ca0968367cb68 Mon Sep 17 00:00:00 2001
From: James Harton <james@automat.nz>
Date: Thu, 12 Oct 2017 09:03:36 +1300
Subject: [PATCH] Tidy up documentation.

---
 lib/ip/address/helpers.ex | 4 +---
 lib/ip/address/ula.ex     | 6 ++----
 lib/ip/prefix/eui64.ex    | 4 +---
 lib/ip/prefix/parser.ex   | 4 +---
 lib/ip/scope.ex           | 2 +-
 5 files changed, 6 insertions(+), 14 deletions(-)

diff --git a/lib/ip/address/helpers.ex b/lib/ip/address/helpers.ex
index 30e8b3e..ff11ace 100644
--- a/lib/ip/address/helpers.ex
+++ b/lib/ip/address/helpers.ex
@@ -1,7 +1,5 @@
 defmodule IP.Address.Helpers do
-  @moduledoc """
-  Helpful macros related to IP addresses.
-  """
+  @moduledoc false
 
   @doc """
   Guard clause macro for "between 0 and 0xffffffff"
diff --git a/lib/ip/address/ula.ex b/lib/ip/address/ula.ex
index 493a98f..9cced87 100644
--- a/lib/ip/address/ula.ex
+++ b/lib/ip/address/ula.ex
@@ -3,15 +3,13 @@ defmodule IP.Address.ULA do
   alias IP.Prefix.EUI64
   use Bitwise
 
-  @moduledoc """
-  Used to generate Unique Local Addresses
-  """
+  @moduledoc false
 
   @doc """
   Generates an IPv6 Unique Local Address
   """
   @spec generate(binary, non_neg_integer, true | false) :: \
-    {:ok, Address.ipv4} | {:error, term}
+    {:ok, Address.ipv6} | {:error, term}
   def generate(mac, subnet_id, locally_assigned)
   when is_binary(mac)
    and is_integer(subnet_id) and subnet_id >= 0 and subnet_id <= 0xffff
diff --git a/lib/ip/prefix/eui64.ex b/lib/ip/prefix/eui64.ex
index 8961399..dc778f8 100644
--- a/lib/ip/prefix/eui64.ex
+++ b/lib/ip/prefix/eui64.ex
@@ -1,9 +1,7 @@
 defmodule IP.Prefix.EUI64 do
   use Bitwise
 
-  @moduledoc """
-  Handles functions related to EUI64 addresses.
-  """
+  @moduledoc false
 
   @doc """
   Parse a mac address into an integer.
diff --git a/lib/ip/prefix/parser.ex b/lib/ip/prefix/parser.ex
index 7a25f0a..218fd3f 100644
--- a/lib/ip/prefix/parser.ex
+++ b/lib/ip/prefix/parser.ex
@@ -2,9 +2,7 @@ defmodule IP.Prefix.Parser do
   alias IP.{Prefix, Address}
   import IP.Prefix.Helpers
 
-  @moduledoc """
-  Used internally by `IP.Prefix.from_string` to parse IP prefixes.
-  """
+  @moduledoc false
 
   @doc """
   Attempts to parse a `prefix` of unknown IP version.
diff --git a/lib/ip/scope.ex b/lib/ip/scope.ex
index a7fa8ef..b81e4b8 100644
--- a/lib/ip/scope.ex
+++ b/lib/ip/scope.ex
@@ -47,7 +47,7 @@ defmodule IP.Scope do
   ]
 
   @doc """
-  Return the scope of `address``
+  Return the scope of `address`
 
   ## Examples