wordcount: set up autogenerated API docs (#14213)

bin/update-readmes.js

@@ -32,7 +32,7 @@ const packages = [
 	'shortcode',
 	'url',
 	'viewport',
-	//'wordcount',
+	'wordcount',
 ];
 
 const getArgsForPackage = ( packageName ) => {

packages/wordcount/README.md

@@ -12,21 +12,34 @@ npm install @wordpress/wordcount --save
 
 _This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using [core-js](https://github.com/zloirock/core-js) or [@babel/polyfill](https://babeljs.io/docs/en/next/babel-polyfill) will add support for these methods. Learn more about it in [Babel docs](https://babeljs.io/docs/en/next/caveats)._
 
-## Accepted Parameters
+## API
 
-```JS
-count( text, type, userSettings )
-````
-count accepts three parameters:
-1. text: A string containing the words/characters to be counted.
-2. type: A string that represents the type of count. The current implementation accepts the strings 'words', 'characters_excluding_spaces', or 'characters_including_spaces'.
-3. userSettings: An object that contains the list of regular expressions that will be used to count. See defaultSettings.js for the defaults.
+<!-- START TOKEN(Autogenerated API docs) -->
 
-## Usage
+### count
 
-```JS
+[src/index.js#L107-L121](src/index.js#L107-L121)
+
+Count some words.
+
+**Usage**
+
+```js
 import { count } from '@wordpress/wordcount';
 const numberOfWords = count( 'Words to count', 'words', {} )
 ```
 
+**Parameters**
+
+-   **text** `String`: The text being processed
+-   **type** `String`: The type of count. Accepts ;words', 'characters_excluding_spaces', or 'characters_including_spaces'.
+-   **userSettings** `Object`: Custom settings object.
+
+**Returns**
+
+`Number`: The word or character count.
+
+
+<!-- END TOKEN(Autogenerated API docs) -->
+
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

packages/wordcount/src/index.js

@@ -95,6 +95,12 @@ function matchCharacters( text, regex, settings ) {
  * @param {String} type         The type of count. Accepts ;words', 'characters_excluding_spaces', or 'characters_including_spaces'.
  * @param {Object} userSettings Custom settings object.
  *
+ * @example
+ * ```js
+ * import { count } from '@wordpress/wordcount';
+ * const numberOfWords = count( 'Words to count', 'words', {} )
+ * ```
+ *
  * @return {Number} The word or character count.
  */