created documentation

fluttercommunity · Jan 11, 2020 · 86d988e · 86d988e
1 parent 8f113c5
commit 86d988e
Show file tree

Hide file tree

Showing 20 changed files with 978 additions and 586 deletions.
diff --git a/doc/api/__404error.html b/doc/api/__404error.html
@@ -4,7 +4,7 @@
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
-  <meta name="generator" content="made with love by dartdoc 0.28.4">
+  <meta name="generator" content="made with love by dartdoc 0.29.3">
   <meta name="description" content="get_it API docs, for the Dart programming language.">
   <title>get_it - Dart API docs</title>
 
@@ -13,7 +13,7 @@
   <link rel="stylesheet" href="static-assets/github.css">
   <link rel="stylesheet" href="static-assets/styles.css">
   <link rel="icon" href="static-assets/favicon.png">
-
+  <!-- header placeholder -->
 </head>
 
 <body>
@@ -73,18 +73,19 @@ <h1>404: Something's gone wrong :-(</h1>
 
 <footer>
   <span class="no-break">
-    get_it 3.0.0
+    get_it
+      3.0.3
   </span>
 
-
+  <!-- footer-text placeholder -->
 </footer>
 
 <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
 <script src="static-assets/typeahead.bundle.min.js"></script>
 <script src="static-assets/highlight.pack.js"></script>
 <script src="static-assets/URI.js"></script>
 <script src="static-assets/script.js"></script>
-
+<!-- footer placeholder -->
 
 </body>
 

diff --git a/doc/api/get_it/FactoryFunc.html b/doc/api/get_it/FactoryFunc.html
@@ -14,7 +14,7 @@
   <link rel="stylesheet" href="static-assets/github.css">
   <link rel="stylesheet" href="static-assets/styles.css">
   <link rel="icon" href="static-assets/favicon.png">
-
+  <!-- header placeholder -->
 </head>
 
 <body>
@@ -57,14 +57,19 @@ <h5>get_it library</h5>
 
 
 
+
       <li class="section-title"><a href="get_it/get_it-library.html#functions">Functions</a></li>
       <li><a href="get_it/throwIf.html">throwIf</a></li>
       <li><a href="get_it/throwIfNot.html">throwIfNot</a></li>
 
 
       <li class="section-title"><a href="get_it/get_it-library.html#typedefs">Typedefs</a></li>
       <li><a href="get_it/FactoryFunc.html">FactoryFunc</a></li>
+      <li><a href="get_it/FactoryFuncAsync.html">FactoryFuncAsync</a></li>
+      <li><a href="get_it/SingletonProviderFunc.html">SingletonProviderFunc</a></li>
 
+      <li class="section-title"><a href="get_it/get_it-library.html#exceptions">Exceptions</a></li>
+      <li><a href="get_it/WaitingTimeOutException-class.html">WaitingTimeOutException</a></li>
     </ol>
   </div><!--/.sidebar-offcanvas-left-->
 
@@ -77,6 +82,9 @@ <h5>get_it library</h5>
 (<wbr>)
     </section>
 
+    <section class="desc markdown">
+      <p>Signature of the factory function used by normal factories</p>
+    </section>
         <section class="summary source-code" id="source">
       <h2><span>Implementation</span></h2>
       <pre class="language-dart"><code class="language-dart">typedef FactoryFunc&lt;T&gt; = T Function();</code></pre>
@@ -91,18 +99,19 @@ <h2><span>Implementation</span></h2>
 
 <footer>
   <span class="no-break">
-    get_it 3.0.0
+    get_it
+      3.0.3
   </span>
 
-
+  <!-- footer-text placeholder -->
 </footer>
 
 <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
 <script src="static-assets/typeahead.bundle.min.js"></script>
 <script src="static-assets/highlight.pack.js"></script>
 <script src="static-assets/URI.js"></script>
 <script src="static-assets/script.js"></script>
-
+<!-- footer placeholder -->
 
 </body>
 

diff --git a/doc/api/get_it/GetIt-class.html b/doc/api/get_it/GetIt-class.html
diff --git a/doc/api/get_it/GetIt/allowReassignment.html b/doc/api/get_it/GetIt/allowReassignment.html
@@ -14,7 +14,7 @@
   <link rel="stylesheet" href="static-assets/github.css">
   <link rel="stylesheet" href="static-assets/styles.css">
   <link rel="icon" href="static-assets/favicon.png">
-
+  <!-- header placeholder -->
 </head>
 
 <body>
@@ -53,37 +53,47 @@
 
     <h5>GetIt class</h5>
     <ol>
-      <li class="section-title"><a href="get_it/GetIt-class.html#constructors">Constructors</a></li>
-      <li><a href="get_it/GetIt/GetIt.asNewInstance.html">asNewInstance</a></li>
 
-      <li class="section-title">
-        <a href="get_it/GetIt-class.html#instance-properties">Properties</a>
-      </li>
-      <li><a href="get_it/GetIt/allowReassignment.html">allowReassignment</a></li>
-      <li><a href="get_it/GetIt/ready.html">ready</a></li>
-      <li><a href="get_it/GetIt/readyFuture.html">readyFuture</a></li>
-      <li class="inherited"><a href="get_it/GetIt/hashCode.html">hashCode</a></li>
-      <li class="inherited"><a href="get_it/GetIt/runtimeType.html">runtimeType</a></li>
+        <li class="section-title"><a href="get_it/GetIt-class.html#constructors">Constructors</a></li>
+        <li><a href="get_it/GetIt/GetIt.asNewInstance.html">asNewInstance</a></li>
 
-      <li class="section-title"><a href="get_it/GetIt-class.html#instance-methods">Methods</a></li>
-      <li><a href="get_it/GetIt/call.html">call</a></li>
-      <li><a href="get_it/GetIt/get.html">get</a></li>
-      <li><a href="get_it/GetIt/registerFactory.html">registerFactory</a></li>
-      <li><a href="get_it/GetIt/registerLazySingleton.html">registerLazySingleton</a></li>
-      <li><a href="get_it/GetIt/registerSingleton.html">registerSingleton</a></li>
-      <li><a href="get_it/GetIt/reset.html">reset</a></li>
-      <li><a href="get_it/GetIt/signalReady.html">signalReady</a></li>
-      <li><a href="get_it/GetIt/unregister.html">unregister</a></li>
-      <li class="inherited"><a href="get_it/GetIt/noSuchMethod.html">noSuchMethod</a></li>
-      <li class="inherited"><a href="get_it/GetIt/toString.html">toString</a></li>
+        <li class="section-title">
+            <a href="get_it/GetIt-class.html#instance-properties">Properties</a>
+        </li>
+        <li><a href="get_it/GetIt/allowReassignment.html">allowReassignment</a></li>
+        <li><a class="deprecated" href="get_it/GetIt/manualReady.html">manualReady</a></li>
+        <li class="inherited"><a href="get_it/GetIt/hashCode.html">hashCode</a></li>
+        <li class="inherited"><a href="get_it/GetIt/runtimeType.html">runtimeType</a></li>
+
+        <li class="section-title"><a href="get_it/GetIt-class.html#instance-methods">Methods</a></li>
+        <li><a href="get_it/GetIt/allReady.html">allReady</a></li>
+        <li><a href="get_it/GetIt/allReadySync.html">allReadySync</a></li>
+        <li><a href="get_it/GetIt/call.html">call</a></li>
+        <li><a href="get_it/GetIt/get.html">get</a></li>
+        <li><a href="get_it/GetIt/getAsync.html">getAsync</a></li>
+        <li><a href="get_it/GetIt/isReady.html">isReady</a></li>
+        <li><a href="get_it/GetIt/isReadySync.html">isReadySync</a></li>
+        <li><a href="get_it/GetIt/registerFactory.html">registerFactory</a></li>
+        <li><a href="get_it/GetIt/registerFactoryAsync.html">registerFactoryAsync</a></li>
+        <li><a href="get_it/GetIt/registerLazySingleton.html">registerLazySingleton</a></li>
+        <li><a href="get_it/GetIt/registerLazySingletonAsync.html">registerLazySingletonAsync</a></li>
+        <li><a href="get_it/GetIt/registerSingleton.html">registerSingleton</a></li>
+        <li><a href="get_it/GetIt/registerSingletonAsync.html">registerSingletonAsync</a></li>
+        <li><a href="get_it/GetIt/reset.html">reset</a></li>
+        <li><a href="get_it/GetIt/resetLazySingleton.html">resetLazySingleton</a></li>
+        <li><a class="deprecated" href="get_it/GetIt/signalReady.html">signalReady</a></li>
+        <li><a href="get_it/GetIt/unregister.html">unregister</a></li>
+        <li class="inherited"><a href="get_it/GetIt/noSuchMethod.html">noSuchMethod</a></li>
+        <li class="inherited"><a href="get_it/GetIt/toString.html">toString</a></li>
+
+        <li class="section-title inherited"><a href="get_it/GetIt-class.html#operators">Operators</a></li>
+        <li class="inherited"><a href="get_it/GetIt/operator_equals.html">operator ==</a></li>
+
+        <li class="section-title"><a href="get_it/GetIt-class.html#static-properties">Static properties</a></li>
+        <li><a href="get_it/GetIt/I.html">I</a></li>
+        <li><a href="get_it/GetIt/instance.html">instance</a></li>
 
-      <li class="section-title inherited"><a href="get_it/GetIt-class.html#operators">Operators</a></li>
-      <li class="inherited"><a href="get_it/GetIt/operator_equals.html">operator ==</a></li>
 
-      <li class="section-title"><a href="get_it/GetIt-class.html#static-properties">Static properties</a></li>
-      <li><a href="get_it/GetIt/allowMultipleInstances.html">allowMultipleInstances</a></li>
-      <li><a href="get_it/GetIt/I.html">I</a></li>
-      <li><a href="get_it/GetIt/instance.html">instance</a></li>
 
 
     </ol>
@@ -117,18 +127,19 @@ <h2><span>Implementation</span></h2>
 
 <footer>
   <span class="no-break">
-    get_it 3.0.0
+    get_it
+      3.0.3
   </span>
 
-
+  <!-- footer-text placeholder -->
 </footer>
 
 <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
 <script src="static-assets/typeahead.bundle.min.js"></script>
 <script src="static-assets/highlight.pack.js"></script>
 <script src="static-assets/URI.js"></script>
 <script src="static-assets/script.js"></script>
-
+<!-- footer placeholder -->
 
 </body>
 

diff --git a/doc/api/get_it/GetIt/call.html b/doc/api/get_it/GetIt/call.html
@@ -14,7 +14,7 @@
   <link rel="stylesheet" href="static-assets/github.css">
   <link rel="stylesheet" href="static-assets/styles.css">
   <link rel="icon" href="static-assets/favicon.png">
-
+  <!-- header placeholder -->
 </head>
 
 <body>
@@ -27,7 +27,7 @@
     <li><a href="index.html">get_it</a></li>
     <li><a href="get_it/get_it-library.html">get_it</a></li>
     <li><a href="get_it/GetIt-class.html">GetIt</a></li>
-    <li class="self-crumb">call&lt;<wbr><span class="type-parameter">T</span>&gt; method</li>
+    <li class="self-crumb">call&lt;<wbr><span class="type-parameter">T</span>&gt; abstract method</li>
   </ol>
   <div class="self-name">call</div>
   <form class="search navbar-right" role="search">
@@ -48,42 +48,52 @@
       <li><a href="index.html">get_it</a></li>
       <li><a href="get_it/get_it-library.html">get_it</a></li>
       <li><a href="get_it/GetIt-class.html">GetIt</a></li>
-      <li class="self-crumb">call&lt;<wbr><span class="type-parameter">T</span>&gt; method</li>
+      <li class="self-crumb">call&lt;<wbr><span class="type-parameter">T</span>&gt; abstract method</li>
     </ol>
 
     <h5>GetIt class</h5>
     <ol>
-      <li class="section-title"><a href="get_it/GetIt-class.html#constructors">Constructors</a></li>
-      <li><a href="get_it/GetIt/GetIt.asNewInstance.html">asNewInstance</a></li>
 
-      <li class="section-title">
-        <a href="get_it/GetIt-class.html#instance-properties">Properties</a>
-      </li>
-      <li><a href="get_it/GetIt/allowReassignment.html">allowReassignment</a></li>
-      <li><a href="get_it/GetIt/ready.html">ready</a></li>
-      <li><a href="get_it/GetIt/readyFuture.html">readyFuture</a></li>
-      <li class="inherited"><a href="get_it/GetIt/hashCode.html">hashCode</a></li>
-      <li class="inherited"><a href="get_it/GetIt/runtimeType.html">runtimeType</a></li>
+        <li class="section-title"><a href="get_it/GetIt-class.html#constructors">Constructors</a></li>
+        <li><a href="get_it/GetIt/GetIt.asNewInstance.html">asNewInstance</a></li>
 
-      <li class="section-title"><a href="get_it/GetIt-class.html#instance-methods">Methods</a></li>
-      <li><a href="get_it/GetIt/call.html">call</a></li>
-      <li><a href="get_it/GetIt/get.html">get</a></li>
-      <li><a href="get_it/GetIt/registerFactory.html">registerFactory</a></li>
-      <li><a href="get_it/GetIt/registerLazySingleton.html">registerLazySingleton</a></li>
-      <li><a href="get_it/GetIt/registerSingleton.html">registerSingleton</a></li>
-      <li><a href="get_it/GetIt/reset.html">reset</a></li>
-      <li><a href="get_it/GetIt/signalReady.html">signalReady</a></li>
-      <li><a href="get_it/GetIt/unregister.html">unregister</a></li>
-      <li class="inherited"><a href="get_it/GetIt/noSuchMethod.html">noSuchMethod</a></li>
-      <li class="inherited"><a href="get_it/GetIt/toString.html">toString</a></li>
+        <li class="section-title">
+            <a href="get_it/GetIt-class.html#instance-properties">Properties</a>
+        </li>
+        <li><a href="get_it/GetIt/allowReassignment.html">allowReassignment</a></li>
+        <li><a class="deprecated" href="get_it/GetIt/manualReady.html">manualReady</a></li>
+        <li class="inherited"><a href="get_it/GetIt/hashCode.html">hashCode</a></li>
+        <li class="inherited"><a href="get_it/GetIt/runtimeType.html">runtimeType</a></li>
+
+        <li class="section-title"><a href="get_it/GetIt-class.html#instance-methods">Methods</a></li>
+        <li><a href="get_it/GetIt/allReady.html">allReady</a></li>
+        <li><a href="get_it/GetIt/allReadySync.html">allReadySync</a></li>
+        <li><a href="get_it/GetIt/call.html">call</a></li>
+        <li><a href="get_it/GetIt/get.html">get</a></li>
+        <li><a href="get_it/GetIt/getAsync.html">getAsync</a></li>
+        <li><a href="get_it/GetIt/isReady.html">isReady</a></li>
+        <li><a href="get_it/GetIt/isReadySync.html">isReadySync</a></li>
+        <li><a href="get_it/GetIt/registerFactory.html">registerFactory</a></li>
+        <li><a href="get_it/GetIt/registerFactoryAsync.html">registerFactoryAsync</a></li>
+        <li><a href="get_it/GetIt/registerLazySingleton.html">registerLazySingleton</a></li>
+        <li><a href="get_it/GetIt/registerLazySingletonAsync.html">registerLazySingletonAsync</a></li>
+        <li><a href="get_it/GetIt/registerSingleton.html">registerSingleton</a></li>
+        <li><a href="get_it/GetIt/registerSingletonAsync.html">registerSingletonAsync</a></li>
+        <li><a href="get_it/GetIt/reset.html">reset</a></li>
+        <li><a href="get_it/GetIt/resetLazySingleton.html">resetLazySingleton</a></li>
+        <li><a class="deprecated" href="get_it/GetIt/signalReady.html">signalReady</a></li>
+        <li><a href="get_it/GetIt/unregister.html">unregister</a></li>
+        <li class="inherited"><a href="get_it/GetIt/noSuchMethod.html">noSuchMethod</a></li>
+        <li class="inherited"><a href="get_it/GetIt/toString.html">toString</a></li>
+
+        <li class="section-title inherited"><a href="get_it/GetIt-class.html#operators">Operators</a></li>
+        <li class="inherited"><a href="get_it/GetIt/operator_equals.html">operator ==</a></li>
+
+        <li class="section-title"><a href="get_it/GetIt-class.html#static-properties">Static properties</a></li>
+        <li><a href="get_it/GetIt/I.html">I</a></li>
+        <li><a href="get_it/GetIt/instance.html">instance</a></li>
 
-      <li class="section-title inherited"><a href="get_it/GetIt-class.html#operators">Operators</a></li>
-      <li class="inherited"><a href="get_it/GetIt/operator_equals.html">operator ==</a></li>
 
-      <li class="section-title"><a href="get_it/GetIt-class.html#static-properties">Static properties</a></li>
-      <li><a href="get_it/GetIt/allowMultipleInstances.html">allowMultipleInstances</a></li>
-      <li><a href="get_it/GetIt/I.html">I</a></li>
-      <li><a href="get_it/GetIt/instance.html">instance</a></li>
 
 
     </ol>
@@ -95,15 +105,18 @@ <h5>GetIt class</h5>
     <section class="multi-line-signature">
       <span class="returntype">T</span>
             <span class="name ">call</span>
-&lt;<wbr><span class="type-parameter">T</span>&gt;(<wbr>[<span class="parameter" id="call-param-instanceName"><span class="type-annotation">String</span> <span class="parameter-name">instanceName</span></span> ])
+&lt;<wbr><span class="type-parameter">T</span>&gt;(<wbr><ol class="parameter-list"><li><span class="parameter" id="call-param-instanceName">[<span class="type-annotation">String</span> <span class="parameter-name">instanceName</span>]</span></li>
+</ol>)
 
     </section>
+    <section class="desc markdown">
+      <p>Callable class so that you can write <code>GetIt.instance&lt;MyType&gt;</code> instead of
+<code>GetIt.instance.get&lt;MyType&gt;</code></p>
+    </section>
 
     <section class="summary source-code" id="source">
       <h2><span>Implementation</span></h2>
-      <pre class="language-dart"><code class="language-dart">T call&lt;T&gt;([String instanceName]) {
-  return get&lt;T&gt;(instanceName);
-}</code></pre>
+      <pre class="language-dart"><code class="language-dart">T call&lt;T&gt;([String instanceName]);</code></pre>
     </section>
 
   </div> <!-- /.main-content -->
@@ -115,18 +128,19 @@ <h2><span>Implementation</span></h2>
 
 <footer>
   <span class="no-break">
-    get_it 3.0.0
+    get_it
+      3.0.3
   </span>
 
-
+  <!-- footer-text placeholder -->
 </footer>
 
 <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
 <script src="static-assets/typeahead.bundle.min.js"></script>
 <script src="static-assets/highlight.pack.js"></script>
 <script src="static-assets/URI.js"></script>
 <script src="static-assets/script.js"></script>
-
+<!-- footer placeholder -->
 
 </body>