Version 1.3.2. Update docs.

okeuday · Jun 1, 2014 · f7c141c · f7c141c
1 parent f5a9bda
commit f7c141c
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 25 deletions.
diff --git a/doc/overview-summary.html b/doc/overview-summary.html
@@ -11,6 +11,6 @@ <h1>The uuid application</h1>
 
 <hr>
 <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
-<p><i>Generated by EDoc, Feb 1 2014, 17:14:30.</i></p>
+<p><i>Generated by EDoc, May 31 2014, 19:53:30.</i></p>
 </body>
 </html>
diff --git a/doc/uuid.html b/doc/uuid.html
@@ -13,9 +13,9 @@ <h1>Module uuid</h1>
 <ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
    <h3><a name="Erlang_UUID_Generation">Erlang UUID Generation</a></h3>
    <a href="http://www.ietf.org/rfc/rfc4122.txt" target="_top"><tt>http://www.ietf.org/rfc/rfc4122.txt</tt></a> is the reference for official UUIDs.
-<p>Copyright © 2011-2013 Michael Truog</p>
+<p>Copyright © 2011-2014 Michael Truog</p>
 
-<p><b>Version:</b> 1.3.1 Feb 1 2014 17:14:30
+<p><b>Version:</b> 1.3.2 May 31 2014 19:53:30
   ------------------------------------------------------------------------</p>
 <p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog [at] gmail (dot) com"><tt>mjtruog [at] gmail (dot) com</tt></a>).</p>
 
@@ -38,6 +38,10 @@ <h3 class="typedecl"><a name="type-state">state()</a></h3>
 <p><tt>state() = #uuid_state{}</tt></p>
 
 
+<h3 class="typedecl"><a name="type-uuid">uuid()</a></h3>
+<p><tt>uuid() = &lt;&lt;_:128&gt;&gt;</tt></p>
+
+
 <h2><a name="index">Function Index</a></h2>
 <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#get_v1-1">get_v1/1</a></td><td>
   <h4><a name="Get_a_v1_UUID.">Get a v1 UUID.</a></h4>.</td></tr>
@@ -130,7 +134,7 @@ <h2><a name="functions">Function Details</a></h2>
 
 <h3 class="function"><a name="get_v1-1">get_v1/1</a></h3>
 <div class="spec">
-<p><tt>get_v1(Uuid_state::#uuid_state{}) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v1(Uuid_state::#uuid_state{}) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_v1_UUID.">Get a v1 UUID.</a></h4>
 </p>
@@ -144,44 +148,44 @@ <h4><a name="Get_the_current_time_value_in_a_manner_consistent_with_the_v1_UUID.
 
 <h3 class="function"><a name="get_v1_time-1">get_v1_time/1</a></h3>
 <div class="spec">
-<p><tt>get_v1_time(Uuid_state::os | erlang | #uuid_state{} | &lt;&lt;_:128&gt;&gt;) -&gt; non_neg_integer()</tt><br></p>
+<p><tt>get_v1_time(Uuid_state::os | erlang | #uuid_state{} | <a href="#type-uuid">uuid()</a>) -&gt; non_neg_integer()</tt><br></p>
 </div><p>
   <h4><a name="Get_the_current_time_value_in_a_manner_consistent_with_the_v1_UUID.">Get the current time value in a manner consistent with the v1 UUID.</a></h4>
   The result is an integer in microseconds.</p>
 
 <h3 class="function"><a name="get_v3-1">get_v3/1</a></h3>
 <div class="spec">
-<p><tt>get_v3(Data::binary()) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v3(Data::binary()) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_v3_UUID.">Get a v3 UUID.</a></h4>
 </p>
 
 <h3 class="function"><a name="get_v3-2">get_v3/2</a></h3>
 <div class="spec">
-<p><tt>get_v3(Namespace::dns | url | oid | x500 | binary(), Data::binary() | iolist()) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v3(Namespace::dns | url | oid | x500 | binary(), Data::binary() | iolist()) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_v3_UUID_in_a_particular_namespace.">Get a v3 UUID in a particular namespace.</a></h4>
 </p>
 
 <h3 class="function"><a name="get_v3_compat-1">get_v3_compat/1</a></h3>
 <div class="spec">
-<p><tt>get_v3_compat(Data::binary()) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v3_compat(Data::binary()) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_compatible_v3_UUID.">Get a compatible v3 UUID.</a></h4>
   Do not use all bits from the checksum so that the UUID matches external
   implementations.</p>
 
 <h3 class="function"><a name="get_v3_compat-2">get_v3_compat/2</a></h3>
 <div class="spec">
-<p><tt>get_v3_compat(Namespace::dns | url | oid | x500 | binary(), Data::binary() | iolist()) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v3_compat(Namespace::dns | url | oid | x500 | binary(), Data::binary() | iolist()) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_compatible_v3_UUID_in_a_particular_namespace.">Get a compatible v3 UUID in a particular namespace.</a></h4>
   Do not use all bits from the checksum so that the UUID matches external
   implementations.</p>
 
 <h3 class="function"><a name="get_v4-0">get_v4/0</a></h3>
 <div class="spec">
-<p><tt>get_v4() -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v4() -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_v4_UUID_(using_crypto/openssl).">Get a v4 UUID (using crypto/openssl).</a></h4>
   crypto:strong_rand_bytes/1 repeats in the same way as
@@ -198,12 +202,12 @@ <h4><a name="Get_a_v4_UUID_(using_crypto/openssl).">Get a v4 UUID (using crypto/
 
 <h3 class="function"><a name="get_v4-1">get_v4/1</a></h3>
 <div class="spec">
-<p><tt>get_v4(X1::strong | weak) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v4(X1::strong | weak) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div>
 
 <h3 class="function"><a name="get_v4_urandom-0">get_v4_urandom/0</a></h3>
 <div class="spec">
-<p><tt>get_v4_urandom() -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v4_urandom() -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_v4_UUID_(using_Wichmann-Hill_2006).">Get a v4 UUID (using Wichmann-Hill 2006).</a></h4>
   random_wh06_int:uniform/1 repeats every 2.66e36 (2^121) approx.
@@ -215,7 +219,7 @@ <h4><a name="Get_a_v4_UUID_(using_Wichmann-Hill_2006).">Get a v4 UUID (using Wic
 
 <h3 class="function"><a name="get_v4_urandom_bigint-0">get_v4_urandom_bigint/0</a></h3>
 <div class="spec">
-<p><tt>get_v4_urandom_bigint() -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v4_urandom_bigint() -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_v4_UUID_(using_Wichmann-Hill_1982).">Get a v4 UUID (using Wichmann-Hill 1982).</a></h4><p>  
 random:uniform/1 repeats every 2.78e13  
@@ -248,37 +252,37 @@ <h4><a name="Get_a_v4_UUID_(using_Wichmann-Hill_1982).">Get a v4 UUID (using Wic
 
 <h3 class="function"><a name="get_v4_urandom_native-0">get_v4_urandom_native/0</a></h3>
 <div class="spec">
-<p><tt>get_v4_urandom_native() -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v4_urandom_native() -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_v4_UUID_(using_Wichmann-Hill_1982).">Get a v4 UUID (using Wichmann-Hill 1982).</a></h4>
   Attempt to only use native integers (Erlang limits integers to 27 bits
   before using bigints) to investigate the speed when using HiPE.</p>
 
 <h3 class="function"><a name="get_v5-1">get_v5/1</a></h3>
 <div class="spec">
-<p><tt>get_v5(Data::binary()) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v5(Data::binary()) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_v5_UUID.">Get a v5 UUID.</a></h4>
 </p>
 
 <h3 class="function"><a name="get_v5-2">get_v5/2</a></h3>
 <div class="spec">
-<p><tt>get_v5(Namespace::dns | url | oid | x500 | binary(), Data::binary() | iolist()) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v5(Namespace::dns | url | oid | x500 | binary(), Data::binary() | iolist()) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_v5_UUID_in_a_particular_namespace.">Get a v5 UUID in a particular namespace.</a></h4>
 </p>
 
 <h3 class="function"><a name="get_v5_compat-1">get_v5_compat/1</a></h3>
 <div class="spec">
-<p><tt>get_v5_compat(Data::binary()) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v5_compat(Data::binary()) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_compatible_v5_UUID.">Get a compatible v5 UUID.</a></h4>
   Do not use all bits from the checksum so that the UUID matches external
   implementations.</p>
 
 <h3 class="function"><a name="get_v5_compat-2">get_v5_compat/2</a></h3>
 <div class="spec">
-<p><tt>get_v5_compat(Namespace::dns | url | oid | x500 | binary(), Data::binary() | iolist()) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>get_v5_compat(Namespace::dns | url | oid | x500 | binary(), Data::binary() | iolist()) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Get_a_compatible_v5_UUID_in_a_particular_namespace.">Get a compatible v5 UUID in a particular namespace.</a></h4>
   Do not use all bits from the checksum so that the UUID matches external
@@ -367,7 +371,7 @@ <h4><a name="Create_new_UUID_state_for_v1_UUID_generation_using_a_specific_type_
 
 <h3 class="function"><a name="string_to_uuid-1">string_to_uuid/1</a></h3>
 <div class="spec">
-<p><tt>string_to_uuid(X1::string() | binary()) -&gt; &lt;&lt;_:128&gt;&gt;</tt><br></p>
+<p><tt>string_to_uuid(X1::string() | binary()) -&gt; <a href="#type-uuid">uuid()</a></tt><br></p>
 </div><p>
   <h4><a name="Convert_a_string_representation_to_a_UUID.">Convert a string representation to a UUID.</a></h4>
 </p>
@@ -381,27 +385,27 @@ <h4><a name="Regression_test.">Regression test.</a></h4>
 
 <h3 class="function"><a name="uuid_to_list-1">uuid_to_list/1</a></h3>
 <div class="spec">
-<p><tt>uuid_to_list(Value::&lt;&lt;_:128&gt;&gt;) -&gt; iolist()</tt><br></p>
+<p><tt>uuid_to_list(Value::<a href="#type-uuid">uuid()</a>) -&gt; iolist()</tt><br></p>
 </div><p>
   <h4><a name="Convert_a_UUID_to_a_list.">Convert a UUID to a list.</a></h4>
 </p>
 
 <h3 class="function"><a name="uuid_to_string-1">uuid_to_string/1</a></h3>
 <div class="spec">
-<p><tt>uuid_to_string(Value::&lt;&lt;_:128&gt;&gt;) -&gt; string()</tt><br></p>
+<p><tt>uuid_to_string(Value::<a href="#type-uuid">uuid()</a>) -&gt; string()</tt><br></p>
 </div><p>
   <h4><a name="Convert_a_UUID_to_a_string_representation.">Convert a UUID to a string representation.</a></h4>
 </p>
 
 <h3 class="function"><a name="uuid_to_string-2">uuid_to_string/2</a></h3>
 <div class="spec">
-<p><tt>uuid_to_string(Value::&lt;&lt;_:128&gt;&gt;, Option::standard | nodash | list_standard | list_nodash | binary_standard | binary_nodash) -&gt; string() | binary()</tt><br></p>
+<p><tt>uuid_to_string(Value::<a href="#type-uuid">uuid()</a>, Option::standard | nodash | list_standard | list_nodash | binary_standard | binary_nodash) -&gt; string() | binary()</tt><br></p>
 </div><p>
   <h4><a name="Convert_a_UUID_to_a_string_representation_based_on_an_option.">Convert a UUID to a string representation based on an option.</a></h4>
 </p>
 <hr>
 
 <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
-<p><i>Generated by EDoc, Feb 1 2014, 17:14:30.</i></p>
+<p><i>Generated by EDoc, May 31 2014, 19:53:30.</i></p>
 </body>
 </html>
diff --git a/rebar.config b/rebar.config
@@ -20,4 +20,4 @@
 {deps,
  [{quickrand, ".*",
    {git, "https://github.com/okeuday/quickrand.git",
-    {tag, "v1.3.1"}}}]}.
+    {tag, "v1.3.2"}}}]}.
diff --git a/src/uuid.app.src b/src/uuid.app.src
@@ -1,6 +1,6 @@
 {application, uuid,
   [{description, "Native UUID Generation"},
-   {vsn, "1.3.1"},
+   {vsn, "1.3.2"},
    {modules, [uuid]},
    {registered, []},
    {applications, [kernel, quickrand, stdlib]}]}.