1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-26 20:39:08 +01:00
metamask-extension/app/scripts/controllers
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
..
ens [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
network [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
permissions Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
transactions Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
alert.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
app-state.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
cached-balances.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
detect-tokens.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
incoming-transactions.js expand transaction constants coverage (#9790) 2020-11-07 01:38:12 -06:00
onboarding.js Track whether seed phrase has been backed up (#9830) 2020-11-10 12:34:20 -03:30
preferences.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
swaps.js Alternative savings fix (#9675) 2020-11-09 13:39:38 -03:30
threebox.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
token-rates.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00