Tidy up documentation.

This commit is contained in:
James Harton 2017-10-12 09:03:36 +13:00
parent 5e258e11ad
commit 9fe8c49296
5 changed files with 6 additions and 14 deletions

View file

@ -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"

View file

@ -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

View file

@ -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.

View file

@ -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.

View file

@ -47,7 +47,7 @@ defmodule IP.Scope do
]
@doc """
Return the scope of `address``
Return the scope of `address`
## Examples