1
0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-11-26 20:39:08 +01:00
metamask-extension/app/scripts/lib
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-ipfs Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
migrator Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
rpc-method-middleware Log web3 usage for functions and nested properties only (#9797) 2020-11-05 14:55:28 -08:00
account-tracker.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
buy-eth-url.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
cleanErrorStack.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
ComposableObservableStore.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
createLoggerMiddleware.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
createOnboardingMiddleware.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
createOriginMiddleware.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
createStreamSink.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
createTabIdMiddleware.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
decrypt-message-manager.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
encryption-public-key-manager.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
enums.js
extractEthjsErrorMessage.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
fetch-with-timeout.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
freezeGlobals.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
get-first-preferred-lang-code.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
getObjStructure.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
local-store.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
message-manager.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
network-store.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
nodeify.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
notification-manager.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
personal-message-manager.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
random-id.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
seed-phrase-verifier.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
setupFetchDebugging.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
setupSentry.js [RFC] add prettier to eslint (#8595) 2020-11-02 17:41:28 -06:00
setupWeb3.js Log web3 usage for functions and nested properties only (#9797) 2020-11-05 14:55:28 -08:00
stream-utils.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
typed-message-manager.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
util.js Make JSDoc formatting more consistent (#9796) 2020-11-10 14:00:41 -03:30
web3-entities.json Log web3 usage for functions and nested properties only (#9797) 2020-11-05 14:55:28 -08:00