mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-11-24 11:01:41 +01:00
14d85b1332
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. |
||
|---|---|---|
| .. | ||
| common.util.js | ||
| common.util.test.js | ||
| confirm-tx.util.js | ||
| confirm-tx.util.test.js | ||
| conversion-util.js | ||
| conversion-util.test.js | ||
| conversions.util.js | ||
| conversions.util.test.js | ||
| fetch-with-cache.js | ||
| fetch-with-cache.test.js | ||
| formatters.js | ||
| gas-time-estimates.util.js | ||
| i18n-helper.js | ||
| i18n-helper.test.js | ||
| switch-direction.js | ||
| token-util.js | ||
| transactions.util.js | ||
| transactions.util.test.js | ||
| util.js | ||
| util.test.js | ||