1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-17 23:13:21 +01:00
metamask-extension/ui/app/contexts
Mark Stacey 14d85b1332
Make JSDoc formatting more consistent (#9796)
A few inconsistencies in JSDoc formatting have been fixed throughout
the project. Many issues remain; these were just the few things that
were easy to fix with a regular expression.

The changes include:

* Using lower-case for primitive types, but capitalizing non-primitive
 types
* Separating the parameter identifier and the description with a dash
* Omitting a dash between the return type and the return description
* Ensuring the parameter type is first and the identifier is second (in
 a few places it was backwards)
* Using square brackets to denote when a parameter is optional, rather
 than putting "(optional)" in the parameter description
* Including a type and identifier with every parameter
* Fixing inconsistent spacing, except where it's used for alignment
* Remove incorrectly formatted `@deprecated` tags that reference non-
 existent properties
* Remove lone comment block without accompanying function

Additionally, one parameter was renamed for clarity.
2020-11-10 14:00:41 -03:30
..
i18n.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
metametrics.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
metametrics.new.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30