mirror of
https://github.com/kremalicious/metamask-extension.git
synced 2024-12-23 09:52:26 +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. |
||
---|---|---|
.. | ||
tests | ||
useCancelTransaction.js | ||
useCopyToClipboard.js | ||
useCurrencyDisplay.js | ||
useCurrentAsset.js | ||
useEqualityCheck.js | ||
useEthFiatAmount.js | ||
useI18nContext.js | ||
useMethodData.js | ||
useMetricEvent.js | ||
usePrevious.js | ||
useRetryTransaction.js | ||
useShouldShowSpeedUp.js | ||
useSwappedTokenValue.js | ||
useSwapsEthToken.js | ||
useTimeout.js | ||
useTokenData.js | ||
useTokenDisplayValue.js | ||
useTokenFiatAmount.js | ||
useTokensToSearch.js | ||
useTokenTracker.js | ||
useTransactionDisplayData.js | ||
useTransactionTimeRemaining.js | ||
useUserPreferencedCurrency.js |