Skip to content

Commit

Permalink
docs(example): 📝 jsdoc-theme updated
Browse files Browse the repository at this point in the history 
Updated the API documentation using the JSDoc template tool.
  • Loading branch information
@AndrewDongminYoo
AndrewDongminYoo committed Apr 11, 2023
1 parent 496e5c7 commit f7196b6
Show file tree
Hide file tree
Showing 9 changed files with 220 additions and 415 deletions.
41 changes: 0 additions & 41 deletions .github/workflows/release-package.yml
View file

This file was deleted.

45 changes: 15 additions & 30 deletions docs/NativeStepCounter.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,35 +22,19 @@
<label for="nav-trigger" class="overlay"></label>

<nav>
<h2>
<a href="index.html">Home</a>
</h2>
<h2><a href="index.html">Home</a></h2>
<h3>Classes</h3>
<ul>
<li>
<a href="UnavailabilityError.html">UnavailabilityError</a>
</li>
<li><a href="UnavailabilityError.html">UnavailabilityError</a></li>
</ul>
<h3>Global</h3>
<ul>
<li>
<a href="global.html#isStepCountingSupported">isStepCountingSupported</a>
</li>
<li>
<a href="global.html#isTurboModuleEnabled">isTurboModuleEnabled</a>
</li>
<li>
<a href="global.html#parseStepData">parseStepData</a>
</li>
<li>
<a href="global.html#RNStepCounter">RNStepCounter</a>
</li>
<li>
<a href="global.html#startStepCounterUpdate">startStepCounterUpdate</a>
</li>
<li>
<a href="global.html#stopStepCounterUpdate">stopStepCounterUpdate</a>
</li>
<li><a href="global.html#RNStepCounter">RNStepCounter</a></li>
<li><a href="global.html#isStepCountingSupported">isStepCountingSupported</a></li>
<li><a href="global.html#isTurboModuleEnabled">isTurboModuleEnabled</a></li>
<li><a href="global.html#parseStepData">parseStepData</a></li>
<li><a href="global.html#startStepCounterUpdate">startStepCounterUpdate</a></li>
<li><a href="global.html#stopStepCounterUpdate">stopStepCounterUpdate</a></li>
</ul>
</nav>

Expand All @@ -59,12 +43,13 @@ <h1 class="page-title">NativeStepCounter.js</h1>

<section>
<article>
<pre class="prettyprint source linenums">
<code>import { TurboModuleRegistry } from 'react-native';
<pre
class="prettyprint source linenums"
><code>import TurboModuleRegistry from 'react-native/Libraries/TurboModule/TurboModuleRegistry';

/**
* `StepCountData` is an object with four properties: `distance`, `steps`, `startDate`, and `endDate`.
*
*
* @typedef StepCountData object - The Object that contains the step count data.
* @property {string} counterType - The type of counter used to count the steps.
* @property {number} steps - The number of steps taken during the time period.
Expand All @@ -76,18 +61,18 @@ <h1 class="page-title">NativeStepCounter.js</h1>
*/

export const NAME = 'RNStepCounter';
export const VERSION = '0.1.11';
export const VERSION = '0.1.15';
export const eventName = 'StepCounter.stepCounterUpdate';
/* Getting enforcing the module from the registry. */
export default TurboModuleRegistry.get('RNStepCounter');
export default TurboModuleRegistry.getEnforcing('RNStepCounter');
//# sourceMappingURL=NativeStepCounter.js.map</code></pre>
</article>
</section>
</div>

<br class="clear" />

<footer>Documentation generated at Sat Apr 08 2023 02:22:20 GMT+0900 (Korean Standard Time)</footer>
<footer>Documentation generated at Tue Apr 11 2023 17:25:09 GMT+0900 (Korean Standard Time)</footer>

<script>
prettyPrint();
Expand Down
58 changes: 16 additions & 42 deletions docs/UnavailabilityError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,35 +22,19 @@
<label for="nav-trigger" class="overlay"></label>

<nav>
<h2>
<a href="index.html">Home</a>
</h2>
<h2><a href="index.html">Home</a></h2>
<h3>Classes</h3>
<ul>
<li>
<a href="UnavailabilityError.html">UnavailabilityError</a>
</li>
<li><a href="UnavailabilityError.html">UnavailabilityError</a></li>
</ul>
<h3>Global</h3>
<ul>
<li>
<a href="global.html#isStepCountingSupported">isStepCountingSupported</a>
</li>
<li>
<a href="global.html#isTurboModuleEnabled">isTurboModuleEnabled</a>
</li>
<li>
<a href="global.html#parseStepData">parseStepData</a>
</li>
<li>
<a href="global.html#RNStepCounter">RNStepCounter</a>
</li>
<li>
<a href="global.html#startStepCounterUpdate">startStepCounterUpdate</a>
</li>
<li>
<a href="global.html#stopStepCounterUpdate">stopStepCounterUpdate</a>
</li>
<li><a href="global.html#RNStepCounter">RNStepCounter</a></li>
<li><a href="global.html#isStepCountingSupported">isStepCountingSupported</a></li>
<li><a href="global.html#isTurboModuleEnabled">isTurboModuleEnabled</a></li>
<li><a href="global.html#parseStepData">parseStepData</a></li>
<li><a href="global.html#startStepCounterUpdate">startStepCounterUpdate</a></li>
<li><a href="global.html#stopStepCounterUpdate">stopStepCounterUpdate</a></li>
</ul>
</nav>

Expand All @@ -73,8 +57,7 @@ <h2>Constructor</h2>
<h4 class="name" id="UnavailabilityError">
<span class="type-signature"></span>new UnavailabilityError<span class="signature"
>(moduleName, propertyName)</span
>
<span class="type-signature"> &rarr; {Error}</span>
><span class="type-signature"> &rarr; {Error}</span>
</h4>

<h5>Parameters:</h5>
Expand All @@ -92,31 +75,23 @@ <h5>Parameters:</h5>

<tbody>
<tr>
<td class="name">
<code>moduleName</code>
</td>
<td class="name"><code>moduleName</code></td>

<td class="type">
<span class="param-type">string</span>
</td>

<td class="description last">
<p>The name of the module.</p>
</td>
<td class="description last"><p>The name of the module.</p></td>
</tr>

<tr>
<td class="name">
<code>propertyName</code>
</td>
<td class="name"><code>propertyName</code></td>

<td class="type">
<span class="param-type">string</span>
</td>

<td class="description last">
<p>The name of the property.</p>
</td>
<td class="description last"><p>The name of the property.</p></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -145,18 +120,17 @@ <h5>Returns:</h5>

<h5>Example</h5>

<pre class="prettyprint">
<code>if (!RNStepCounter.startStepCounterUpdate) {
<pre class="prettyprint"><code>if (!RNStepCounter.startStepCounterUpdate) {
throw new UnavailabilityError(NativeModuleName, eventName);
}</code></pre>
}</code></pre>
</div>
</article>
</section>
</div>

<br class="clear" />

<footer>Documentation generated at Sat Apr 08 2023 02:22:20 GMT+0900 (Korean Standard Time)</footer>
<footer>Documentation generated at Tue Apr 11 2023 17:25:09 GMT+0900 (Korean Standard Time)</footer>

<script>
prettyPrint();
Expand Down
Loading

0 comments on commit f7196b6

Please sign in to comment.