1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
metamask-extension/app/scripts
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
..
account-import-strategies Create custom addHexPrefix function (#9306) 2020-11-06 13:18:00 -08:00
controllers Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
lib Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
migrations expand transaction constants coverage (#9790) 2020-11-07 01:38:12 -06:00
platforms expand transaction constants coverage (#9790) 2020-11-07 01:38:12 -06:00
background.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
chromereload.js Fix console.error references 2016-08-29 17:32:39 -07:00
contentscript.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
first-time-state.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
inpage.js Warn instead of throw on duplicate web3 and do not inject (#9832) 2020-11-09 10:40:40 -08:00
metamask-controller.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
phishing-detect.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
ui.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00