Skip to content

Commit

Permalink
improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@lucaong
lucaong committed Apr 25, 2020
1 parent b5ca085 commit e8f8412
Show file tree
Hide file tree
Showing 6 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/MiniSearch.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ <h3 class="subsection-title">Methods</h3>



<h4 class="name" id=".getDefault"><span class="type-signature">(static) </span>getDefault<span class="signature">(optionName)</span><span class="type-signature"> &rarr; {*}</span></h4>
<h4 class="name" id=".getDefault"><span class="type-signature">(static) </span>getDefault<span class="signature">(optionName)</span><span class="type-signature"> &rarr; {any}</span></h4>



Expand Down Expand Up @@ -791,7 +791,7 @@ <h5>Returns:</h5>
</dt>
<dd>

<span class="param-type">*</span>
<span class="param-type">any</span>


</dd>
Expand Down Expand Up @@ -3684,7 +3684,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 13:58:36 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 14:15:21 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
4 changes: 2 additions & 2 deletions docs/MiniSearch.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -537,7 +537,7 @@ <h1 class="page-title">MiniSearch.js</h1>
* the given name exists.
*
* @param {string} optionName - name of the option
* @return {*} the default value of the given option
* @return {any} the default value of the given option
*
* @example
* // Get default tokenizer
Expand Down Expand Up @@ -853,7 +853,7 @@ <h1 class="page-title">MiniSearch.js</h1>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 13:58:36 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 14:15:21 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/SearchableMap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2718,7 +2718,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 13:58:36 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 14:15:21 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/SearchableMap_SearchableMap.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ <h1 class="page-title">SearchableMap/SearchableMap.js</h1>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 13:58:36 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 14:15:21 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ <h2>Contributing</h2>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 13:58:36 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Apr 25 2020 14:15:21 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
2 changes: 1 addition & 1 deletion src/MiniSearch.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -491,7 +491,7 @@ class MiniSearch {
* the given name exists.
*
* @param {string} optionName - name of the option
* @return {*} the default value of the given option
* @return {any} the default value of the given option
*
* @example
* // Get default tokenizer
Expand Down

0 comments on commit e8f8412

Please sign in to comment.