docs: add documentation for component methods

[renrizzolo]

Add Methods section to docs

Description

Methods are available in the props.json file but they're not being documented.

Was a little complicated having a single table for all methods like the PropTypes table, because of having to do multiple rows for params within the method row. So I've separated them into blocks with a params table.

The screen shot aims to show the full documentation capability using JSDoc.

e.g

/**
* stateToHTML method description
* @param {string} input - the input string
* @param {boolean} anotherParam - a boolean flag
* @returns {object} the return type contains all the stuff you need
**/

Does this PR introduce a breaking change?

• Yes
• No

Manual testing step?

Screenshots (if appropriate):

[codecov]

Codecov Report

Merging #1208 (3b59438) into master (1efa941) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master     #1208   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           93        93           
  Lines         1381      1381           
  Branches       343       343           
=========================================
  Hits          1381      1381           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1efa941...3b59438. Read the comment docs.

[pphminions]

LGTM 🍏

[pphminions]

merging 🚀