aboutsummaryrefslogtreecommitdiffstats
path: root/packages/react-docs/src/components/signature.tsx
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-10-01 23:37:44 +0800
committerGitHub <noreply@github.com>2018-10-01 23:37:44 +0800
commitbad6761e13d5348eccdf8ae37e83b152740dbe45 (patch)
tree9687e509f18164ac78ff612ead79ebd9eb977527 /packages/react-docs/src/components/signature.tsx
parentac14dd2b29b42ef4d2a46db9b70d4d30cf9bd40f (diff)
parent6ffdc318e7b15cc43f4b3e0ffc39786cdf4c5c05 (diff)
downloaddexon-sol-tools-bad6761e13d5348eccdf8ae37e83b152740dbe45.tar
dexon-sol-tools-bad6761e13d5348eccdf8ae37e83b152740dbe45.tar.gz
dexon-sol-tools-bad6761e13d5348eccdf8ae37e83b152740dbe45.tar.bz2
dexon-sol-tools-bad6761e13d5348eccdf8ae37e83b152740dbe45.tar.lz
dexon-sol-tools-bad6761e13d5348eccdf8ae37e83b152740dbe45.tar.xz
dexon-sol-tools-bad6761e13d5348eccdf8ae37e83b152740dbe45.tar.zst
dexon-sol-tools-bad6761e13d5348eccdf8ae37e83b152740dbe45.zip
Merge pull request #1099 from 0xProject/solidityDocRefImprovements
Solidity Doc Improvements
Diffstat (limited to 'packages/react-docs/src/components/signature.tsx')
-rw-r--r--packages/react-docs/src/components/signature.tsx19
1 files changed, 14 insertions, 5 deletions
diff --git a/packages/react-docs/src/components/signature.tsx b/packages/react-docs/src/components/signature.tsx
index a690a1f03..1f3dd0ee8 100644
--- a/packages/react-docs/src/components/signature.tsx
+++ b/packages/react-docs/src/components/signature.tsx
@@ -19,12 +19,14 @@ export interface SignatureProps {
callPath?: string;
docsInfo: DocsInfo;
isInPopover: boolean;
+ isFallback?: boolean;
}
const defaultProps = {
shouldHideMethodName: false,
shouldUseArrowSyntax: false,
callPath: '',
+ isFallback: false,
};
export const Signature: React.SFC<SignatureProps> = (props: SignatureProps) => {
@@ -34,6 +36,7 @@ export const Signature: React.SFC<SignatureProps> = (props: SignatureProps) => {
props.docsInfo,
sectionName,
props.isInPopover,
+ props.name,
props.typeDefinitionByName,
);
const paramStringArray: any[] = [];
@@ -75,7 +78,7 @@ export const Signature: React.SFC<SignatureProps> = (props: SignatureProps) => {
return (
<span style={{ fontSize: 15 }}>
{props.callPath}
- {methodName}
+ {props.isFallback ? '' : methodName}
{typeParameterIfExists}({hasMoreThenTwoParams && <br />}
{paramStringArray})
{props.returnType && (
@@ -101,9 +104,10 @@ function renderParameters(
docsInfo: DocsInfo,
sectionName: string,
isInPopover: boolean,
+ name: string,
typeDefinitionByName?: TypeDefinitionByName,
): React.ReactNode[] {
- const params = _.map(parameters, (p: Parameter) => {
+ const params = _.map(parameters, (p: Parameter, i: number) => {
const isOptional = p.isOptional;
const hasDefaultValue = !_.isUndefined(p.defaultValue);
const type = (
@@ -116,9 +120,14 @@ function renderParameters(
/>
);
return (
- <span key={`param-${p.type}-${p.name}`}>
- {p.name}
- {isOptional && '?'}: {type}
+ <span key={`param-${JSON.stringify(p.type)}-${name}-${i}`}>
+ {!_.isEmpty(p.name) && (
+ <span>
+ {p.name}
+ {isOptional && '?'}:{' '}
+ </span>
+ )}
+ {type}
{hasDefaultValue && ` = ${p.defaultValue}`}
</span>
);