Android docs: updated for release 3.2.3

polarofficial · Nov 5, 2021 · 8b70cd0 · 8b70cd0
1 parent 8176a4a
commit 8b70cd0
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/polar-sdk-android/docs/html/com/polar/sdk/api/PolarBleApi.html b/polar-sdk-android/docs/html/com/polar/sdk/api/PolarBleApi.html
@@ -265,7 +265,7 @@ <h3>Method Summary</h3>
                                             </td>
                                             <th class="colSecond" scope="row"><code><a href=PolarBleApi.html#shutDown()>shutDown</a>() </code>
                                             </th>
-                                            <td class="colLast">Must be called when application is destroyed.</td>
+                                            <td class="colLast">Releases the SDK resources.</td>
                                         </tr>
 
                                         <tr id="i2" class="altColor">
@@ -582,7 +582,7 @@ <h4>setMtu</h4>
                                     <li class="blockList">
                                         <h4>shutDown</h4>
                                         <pre class="methodSignature"> abstract void <a href=PolarBleApi.html#shutDown()>shutDown</a>()</pre>
-                                        <div class="block"><p>Must be called when application is destroyed.</p></div>
+                                        <div class="block"><p>Releases the SDK resources. When the SDK is used on scope ofthe android component (e.g. Activity or Service) then the shutDown may be calledon component destroy function. After shutDown the new instance of the SDK is needed:</p></div>
 
                                         <!-- TODO missing return annotation -->
                                     </li>

diff --git a/polar-sdk-android/docs/html/com/polar/sdk/impl/BDBleApiImpl.html b/polar-sdk-android/docs/html/com/polar/sdk/impl/BDBleApiImpl.html
@@ -202,7 +202,7 @@ <h3>Method Summary</h3>
                                             </td>
                                             <th class="colSecond" scope="row"><code><a href=BDBleApiImpl.html#shutDown()>shutDown</a>() </code>
                                             </th>
-                                            <td class="colLast">Must be called when application is destroyed.</td>
+                                            <td class="colLast">Releases the SDK resources.</td>
                                         </tr>
 
                                         <tr id="i4" class="altColor">
@@ -571,7 +571,7 @@ <h4>setMtu</h4>
                                     <li class="blockList">
                                         <h4>shutDown</h4>
                                         <pre class="methodSignature"> void <a href=BDBleApiImpl.html#shutDown()>shutDown</a>()</pre>
-                                        <div class="block"><p>Must be called when application is destroyed.</p></div>
+                                        <div class="block"><p>Releases the SDK resources. When the SDK is used on scope ofthe android component (e.g. Activity or Service) then the shutDown may be calledon component destroy function. After shutDown the new instance of the SDK is needed:</p></div>
 
                                         <!-- TODO missing return annotation -->
                                     </li>

diff --git a/polar-sdk-android/docs/html/index-files/index-15.html b/polar-sdk-android/docs/html/index-files/index-15.html
@@ -573,7 +573,7 @@ <h2 class="title">S</h2>
 
 
             </dt>
-            <dd>Must be called when application is destroyed.</dd>
+            <dd>Releases the SDK resources.</dd>
 
 
             <dt>
@@ -586,7 +586,7 @@ <h2 class="title">S</h2>
 
 
             </dt>
-            <dd>Must be called when application is destroyed.</dd>
+            <dd>Releases the SDK resources.</dd>
 
 
             <dt>
-Original file line number
+Diff line change
@@ Expand Up / @@ -573,7 +573,7 @@ <h2 class="title">S</h2> @@
                 </dt>
-                <dd>Must be called when application is destroyed.</dd>
+                <dd>Releases the SDK resources.</dd>
                 <dt>
@@ Expand All / @@ -586,7 +586,7 @@ <h2 class="title">S</h2> @@
                 </dt>
-                <dd>Must be called when application is destroyed.</dd>
+                <dd>Releases the SDK resources.</dd>
                 <dt>
@@ Expand Down @@