docs: mark functions as async

nwutils · Dec 1, 2023 · d8682d2 · d8682d2
1 parent 4cb68b7
commit d8682d2
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 8 deletions.
diff --git a/docs/get.js.html b/docs/get.js.html
@@ -60,6 +60,7 @@ <h1 class="page-title">Source: get.js</h1>
 /**
  * Get binaries.
  *
+ * @async
  * @function
  * @param  {GetOptions}    options  Get mode options
  * @return {Promise&lt;void>}
@@ -487,7 +488,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Nov 30 2023 23:21:46 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Nov 30 2023 23:45:21 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/global.html b/docs/global.html
@@ -104,7 +104,7 @@ <h3 class="subsection-title">Methods</h3>
 
 
 
-    <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
+    <h4 class="name" id="get"><span class="type-signature">(async) </span>get<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
 
 
 
@@ -205,7 +205,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="get.js.html">get.js</a>, <a href="get.js.html#line84">line 84</a>
+        <a href="get.js.html">get.js</a>, <a href="get.js.html#line85">line 85</a>
     </li></ul></dd>
 
 
@@ -301,7 +301,7 @@ <h5>Examples</h5>
 
 
 
-    <h4 class="name" id="run"><span class="type-signature"></span>run<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
+    <h4 class="name" id="run"><span class="type-signature">(async) </span>run<span class="signature">(options)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
 
 
 
@@ -402,7 +402,7 @@ <h5>Parameters:</h5>
 
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="run.js.html">run.js</a>, <a href="run.js.html#line35">line 35</a>
+        <a href="run.js.html">run.js</a>, <a href="run.js.html#line36">line 36</a>
     </li></ul></dd>
 
 
@@ -1395,7 +1395,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Nov 30 2023 23:21:46 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Nov 30 2023 23:45:21 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/index.html b/docs/index.html
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Nov 30 2023 23:21:46 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Nov 30 2023 23:45:21 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/docs/run.js.html b/docs/run.js.html
@@ -50,6 +50,7 @@ <h1 class="page-title">Source: run.js</h1>
 /**
  * Run NW.js application
  *
+ * @async
  * @function
  * @param  {options}       options  Run mode options
  * @return {Promise&lt;void>}
@@ -123,7 +124,7 @@ <h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><a href="global.htm
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Nov 30 2023 23:21:46 GMT-0500 (Eastern Standard Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Thu Nov 30 2023 23:45:21 GMT-0500 (Eastern Standard Time)
 </footer>
 
 <script> prettyPrint(); </script>

diff --git a/src/get.js b/src/get.js
@@ -32,6 +32,7 @@ const { ARCH_KV, PLATFORM_KV, replaceFfmpeg } = util;
 /**
  * Get binaries.
  *
+ * @async
  * @function
  * @param  {GetOptions}    options  Get mode options
  * @return {Promise<void>}

diff --git a/src/run.js b/src/run.js
@@ -22,6 +22,7 @@ const { log } = logger;
 /**
  * Run NW.js application
  *
+ * @async
  * @function
  * @param  {options}       options  Run mode options
  * @return {Promise<void>}