Skip to content
This repository has been archived by the owner on Oct 10, 2018. It is now read-only.

Commit

Permalink
regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Rob Phoenix committed May 4, 2016
1 parent 5dcdfb0 commit 9e09115
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions doc/IPA.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,8 @@ <h2>
<a href="#to_cidr/1">to_cidr(mask)</a>
</div>

<div class="summary-synopsis"><p>Converts a dotted decimal Subnet Mask to CIDR notation</p>
<div class="summary-synopsis"><p>Converts a dotted decimal, hex, binary, tuple &amp; dotted binary
Subnet Mask to CIDR notation</p>
</div>

</div>
Expand Down Expand Up @@ -199,7 +200,7 @@ <h2>
<a href="#valid_address?/1">valid_address?(addr)</a>
</div>

<div class="summary-synopsis"><p>Checks if the given dotted decimal IP address is valid</p>
<div class="summary-synopsis"><p>Checks if the given IP address is valid</p>
</div>

</div>
Expand Down Expand Up @@ -453,7 +454,8 @@ <h2>Example</h2>
</div>

<section class="docstring">
<p>Converts a dotted decimal Subnet Mask to CIDR notation.</p>
<p>Converts a dotted decimal, hex, binary, tuple &amp; dotted binary
Subnet Mask to CIDR notation.</p>
<h2>Examples</h2>
<pre><code class="iex elixir">iex&gt; IPA.to_cidr(&quot;255.255.255.0&quot;)
24
Expand All @@ -463,6 +465,8 @@ <h2>Examples</h2>
24
iex&gt; IPA.to_cidr({255, 255, 255, 0})
24
iex&gt; IPA.to_cidr(&quot;11111111.11111111.11111111.00000000&quot;)
24
iex&gt; IPA.to_cidr(&quot;192.168.0.1&quot;)
** (SubnetError) Invalid Subnet Mask</code></pre>

Expand Down Expand Up @@ -604,7 +608,7 @@ <h4 class="specs-title">Specs</h4>
</div>

<section class="docstring">
<p>Checks if the given dotted decimal IP address is valid.</p>
<p>Checks if the given IP address is valid.</p>
<p>Does not currently take into consideration
the fact that <code class="inline">127.1</code> can be considered a valid IP address
that translates to <code class="inline">127.0.0.1</code>.</p>
Expand Down Expand Up @@ -650,8 +654,6 @@ <h4 class="specs-title">Specs</h4>

<section class="docstring">
<p>Checks if the given subnet mask is valid.</p>
<p>Works with CIDR notation, as well as dotted decimal and
dotted binary.</p>
<h2>Examples</h2>
<pre><code class="iex elixir">iex&gt; IPA.valid_mask?(24)
true
Expand Down

0 comments on commit 9e09115

Please sign in to comment.