Skip to content

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daegalus committed Apr 5, 2023
1 parent bfb0a9c commit b1d9daf
Show file tree
Hide file tree
Showing 177 changed files with 4,035 additions and 1,447 deletions.
4 changes: 2 additions & 2 deletions doc/api/__404error.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ <h5><span class="package-name">uuid</span> <span class="package-kind">package</s
<li><a href="data/data-library.html">data</a></li>
<li><a href="enums/enums-library.html">enums</a></li>
<li><a href="parsing/parsing-library.html">parsing</a></li>
<li><a href="rng/rng-library.html">rng</a></li>
<li><a href="uuid/uuid-library.html">uuid</a></li>
<li><a href="uuid_util/uuid_util-library.html">uuid_util</a></li>
<li><a href="uuid_value/uuid_value-library.html">uuid_value</a></li>
<li><a href="v1/v1-library.html">v1</a></li>
<li><a href="v4/v4-library.html">v4</a></li>
Expand All @@ -101,7 +101,7 @@ <h5><span class="package-name">uuid</span> <span class="package-kind">package</s
<footer>
<span class="no-break">
uuid
4.0.0-beta2
4.0.0-beta3
</span>


Expand Down
62 changes: 18 additions & 44 deletions doc/api/data/GlobalOptions-class.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,7 @@ <h1><span class="kind-class">GlobalOptions</span> class

<section class="desc markdown">
<p><a href="../data/GlobalOptions-class.html">GlobalOptions</a> stores the global options passed into the library on instantiation.
<a href="../data/GlobalOptions/rng.html">rng</a> is the random number generator function to use. Defaults to UuidUtil.mathRNG
<a href="../data/GlobalOptions/namedArgs.html">namedArgs</a> is a map of named arguments to pass to the RNG function
<a href="../data/GlobalOptions/positionalArgs.html">positionalArgs</a> is a list of positional arguments to pass to the RNG function</p>
<a href="../data/GlobalOptions/rng.html">GlobalOptions.rng</a> is the random number generator class to use. Defaults to MathRNG() <a href="../rng/MathRNG-class.html">MathRNG</a></p>
</section>


Expand All @@ -70,7 +68,7 @@ <h2>Constructors</h2>

<dl class="constructor-summary-list">
<dt id="GlobalOptions" class="callable">
<span class="name"><a href="../data/GlobalOptions/GlobalOptions.html">GlobalOptions</a></span><span class="signature">(<span class="parameter" id="-param-rng"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Function-class.html">Function</a>?</span> <span class="parameter-name">rng</span>, </span><span class="parameter" id="-param-namedArgs"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/Symbol-class.html">Symbol</a></span>, <span class="type-parameter">dynamic</span>&gt;</span>?</span> <span class="parameter-name">namedArgs</span>, </span><span class="parameter" id="-param-positionalArgs"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a>?</span> <span class="parameter-name">positionalArgs</span></span>)</span>
<span class="name"><a href="../data/GlobalOptions/GlobalOptions.html">GlobalOptions</a></span><span class="signature">(<span class="parameter" id="-param-rng"><span class="type-annotation"><a href="../rng/RNG-class.html">RNG</a>?</span> <span class="parameter-name">rng</span></span>)</span>
</dt>
<dd>

Expand All @@ -84,41 +82,19 @@ <h2>Properties</h2>

<dl class="properties">
<dt id="hashCode" class="property inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span>
<span class="name"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/hashCode.html">hashCode</a></span>
<span class="signature">&#8594; <a href="https://api.dart.dev/stable/2.19.3/dart-core/int-class.html">int</a></span>

</dt>
<dd class="inherited">
The hash code for this object.
<div class="features"><span class="feature">read-only</span><span class="feature">inherited</span></div>

</dd>

<dt id="namedArgs" class="property">
<span class="name"><a href="../data/GlobalOptions/namedArgs.html">namedArgs</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/Symbol-class.html">Symbol</a></span>, <span class="type-parameter">dynamic</span>&gt;</span>?</span>

</dt>
<dd>

<div class="features"><span class="feature">final</span></div>

</dd>

<dt id="positionalArgs" class="property">
<span class="name"><a href="../data/GlobalOptions/positionalArgs.html">positionalArgs</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a>?</span>

</dt>
<dd>

<div class="features"><span class="feature">final</span></div>

</dd>

<dt id="rng" class="property">
<span class="name"><a href="../data/GlobalOptions/rng.html">rng</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Function-class.html">Function</a>?</span>
<span class="signature">&#8594; <a href="../rng/RNG-class.html">RNG</a>?</span>

</dt>
<dd>
Expand All @@ -128,8 +104,8 @@ <h2>Properties</h2>
</dd>

<dt id="runtimeType" class="property inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></span>
<span class="signature">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/Type-class.html">Type</a></span>
<span class="name"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/runtimeType.html">runtimeType</a></span>
<span class="signature">&#8594; <a href="https://api.dart.dev/stable/2.19.3/dart-core/Type-class.html">Type</a></span>

</dt>
<dd class="inherited">
Expand All @@ -148,7 +124,7 @@ <h2>Properties</h2>
<h2>Methods</h2>
<dl class="callables">
<dt id="noSuchMethod" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
<span class="name"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/noSuchMethod.html">noSuchMethod</a></span><span class="signature">(<wbr><span class="parameter" id="noSuchMethod-param-invocation"><span class="type-annotation"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Invocation-class.html">Invocation</a></span> <span class="parameter-name">invocation</span></span>)
<span class="returntype parameter">&#8594; dynamic</span>
</span>

Expand All @@ -161,8 +137,8 @@ <h2>Methods</h2>
</dd>

<dt id="toString" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span>
<span class="name"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/toString.html">toString</a></span><span class="signature">(<wbr>)
<span class="returntype parameter">&#8594; <a href="https://api.dart.dev/stable/2.19.3/dart-core/String-class.html">String</a></span>
</span>


Expand All @@ -182,8 +158,8 @@ <h2>Methods</h2>
<h2>Operators</h2>
<dl class="callables">
<dt id="operator ==" class="callable inherited">
<span class="name"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
<span class="returntype parameter">&#8594; <a href="https://api.flutter.dev/flutter/dart-core/bool-class.html">bool</a></span>
<span class="name"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/operator_equals.html">operator ==</a></span><span class="signature">(<wbr><span class="parameter" id="==-param-other"><span class="type-annotation"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object-class.html">Object</a></span> <span class="parameter-name">other</span></span>)
<span class="returntype parameter">&#8594; <a href="https://api.dart.dev/stable/2.19.3/dart-core/bool-class.html">bool</a></span>
</span>


Expand Down Expand Up @@ -251,18 +227,16 @@ <h5>data library</h5>
<li class="section-title">
<a href="../data/GlobalOptions-class.html#instance-properties">Properties</a>
</li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
<li><a href="../data/GlobalOptions/namedArgs.html">namedArgs</a></li>
<li><a href="../data/GlobalOptions/positionalArgs.html">positionalArgs</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/hashCode.html">hashCode</a></li>
<li><a href="../data/GlobalOptions/rng.html">rng</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/runtimeType.html">runtimeType</a></li>

<li class="section-title inherited"><a href="../data/GlobalOptions-class.html#instance-methods">Methods</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/toString.html">toString</a></li>

<li class="section-title inherited"><a href="../data/GlobalOptions-class.html#operators">Operators</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/operator_equals.html">operator ==</a></li>



Expand All @@ -276,7 +250,7 @@ <h5>data library</h5>
<footer>
<span class="no-break">
uuid
4.0.0-beta2
4.0.0-beta3
</span>


Expand Down
20 changes: 8 additions & 12 deletions doc/api/data/GlobalOptions/GlobalOptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,7 @@ <h1><span class="kind-constructor">GlobalOptions</span> constructor

<section class="multi-line-signature">
const
<span class="name ">GlobalOptions</span>(<wbr><ol class="parameter-list"><li><span class="parameter" id="-param-rng"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Function-class.html">Function</a>?</span> <span class="parameter-name">rng</span>, </span></li>
<li><span class="parameter" id="-param-namedArgs"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/Map-class.html">Map</a><span class="signature">&lt;<wbr><span class="type-parameter"><a href="https://api.flutter.dev/flutter/dart-core/Symbol-class.html">Symbol</a></span>, <span class="type-parameter">dynamic</span>&gt;</span>?</span> <span class="parameter-name">namedArgs</span>, </span></li>
<li><span class="parameter" id="-param-positionalArgs"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/List-class.html">List</a>?</span> <span class="parameter-name">positionalArgs</span></span></li>
<span class="name ">GlobalOptions</span>(<wbr><ol class="parameter-list"><li><span class="parameter" id="-param-rng"><span class="type-annotation"><a href="../../rng/RNG-class.html">RNG</a>?</span> <span class="parameter-name">rng</span></span></li>
</ol>)
</section>

Expand All @@ -68,7 +66,7 @@ <h1><span class="kind-constructor">GlobalOptions</span> constructor

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
<pre class="language-dart"><code class="language-dart">const GlobalOptions(this.rng, this.namedArgs, this.positionalArgs);</code></pre>
<pre class="language-dart"><code class="language-dart">const GlobalOptions(this.rng);</code></pre>
</section>


Expand Down Expand Up @@ -99,18 +97,16 @@ <h5>GlobalOptions class</h5>
<li class="section-title">
<a href="../../data/GlobalOptions-class.html#instance-properties">Properties</a>
</li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
<li><a href="../../data/GlobalOptions/namedArgs.html">namedArgs</a></li>
<li><a href="../../data/GlobalOptions/positionalArgs.html">positionalArgs</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/hashCode.html">hashCode</a></li>
<li><a href="../../data/GlobalOptions/rng.html">rng</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/runtimeType.html">runtimeType</a></li>

<li class="section-title inherited"><a href="../../data/GlobalOptions-class.html#instance-methods">Methods</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/toString.html">toString</a></li>

<li class="section-title inherited"><a href="../../data/GlobalOptions-class.html#operators">Operators</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/operator_equals.html">operator ==</a></li>



Expand All @@ -127,7 +123,7 @@ <h5>GlobalOptions class</h5>
<footer>
<span class="no-break">
uuid
4.0.0-beta2
4.0.0-beta3
</span>


Expand Down
18 changes: 8 additions & 10 deletions doc/api/data/GlobalOptions/rng.html
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ <h1><span class="kind-property">rng</span> property

<section class="multi-line-signature">

<a href="https://api.flutter.dev/flutter/dart-core/Function-class.html">Function</a>?
<a href="../../rng/RNG-class.html">RNG</a>?
<span class="name ">rng</span>
<div class="features"><span class="feature">final</span></div>

Expand All @@ -66,7 +66,7 @@ <h1><span class="kind-property">rng</span> property

<section class="summary source-code" id="source">
<h2><span>Implementation</span></h2>
<pre class="language-dart"><code class="language-dart">final Function? rng;</code></pre>
<pre class="language-dart"><code class="language-dart">final RNG? rng;</code></pre>
</section>


Expand Down Expand Up @@ -97,18 +97,16 @@ <h5>GlobalOptions class</h5>
<li class="section-title">
<a href="../../data/GlobalOptions-class.html#instance-properties">Properties</a>
</li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/hashCode.html">hashCode</a></li>
<li><a href="../../data/GlobalOptions/namedArgs.html">namedArgs</a></li>
<li><a href="../../data/GlobalOptions/positionalArgs.html">positionalArgs</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/hashCode.html">hashCode</a></li>
<li><a href="../../data/GlobalOptions/rng.html">rng</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/runtimeType.html">runtimeType</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/runtimeType.html">runtimeType</a></li>

<li class="section-title inherited"><a href="../../data/GlobalOptions-class.html#instance-methods">Methods</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/toString.html">toString</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/noSuchMethod.html">noSuchMethod</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/toString.html">toString</a></li>

<li class="section-title inherited"><a href="../../data/GlobalOptions-class.html#operators">Operators</a></li>
<li class="inherited"><a href="https://api.flutter.dev/flutter/dart-core/Object/operator_equals.html">operator ==</a></li>
<li class="inherited"><a href="https://api.dart.dev/stable/2.19.3/dart-core/Object/operator_equals.html">operator ==</a></li>



Expand All @@ -125,7 +123,7 @@ <h5>GlobalOptions class</h5>
<footer>
<span class="no-break">
uuid
4.0.0-beta2
4.0.0-beta3
</span>


Expand Down
Loading

0 comments on commit b1d9daf

Please sign in to comment.