j-a-y-h / react-uniformed / 155

98%

push

travis-ci-com

Feature/using typedoc (#31)

* Added support for tsdoc generation to markdown

* Adds the tsdoc eslint plugin and removes jsdoc eslint rules

* Fixes configs for typedoc

* Fixes tsdoc issues

* Replaces jsdoc-to-markdown with typedoc

* Switches over to library mode for typedoc

* Updates useSubmission documentation

* Switches to typedoc module mode

* Cleaned up useValidation docs

* Bumps typedoc version

* Adds more documentation to useTouch

* Adds a basic example for useTouch

* Adds a JSX example for useTouch

* Updates useSubmission documentation

* Updates first example for useSubmission

* Cleans up useSubmission docs

* Updates useSettersAsRefEventHandler docs

* Moves example to the specific overload function

* Added todo

* Updates useNormalizers docs

* Improves useNormalizers doc

* Improves the useHandlers function

* Misc doc updates

* Improves useForm documentation

* Converts UseFormsHook to interface for better use in typedoc

* Updates useFields docs

* Updates documentation

* Imrpoves documentation

* Improves useConstraints docs

* misc doc improvements

* Converts tsdocs examples to jsdoc compatible docs

* Replaces API docs with a generic docs generated by typedoc

* Small doc updates to useConstraints

* Minor docs update

* Cheats the code coverage

220 of 241 branches covered (91.29%)

Branch coverage included in aggregate %.

369 of 377 relevant lines covered (97.88%)

31.52 hits per line