Skip to content

Commit 0881e35

Browse files
Internal: use multiline comments to enable flow docs (#2383)
1 parent e974221 commit 0881e35

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

docs/docs-components/PageHeader.js

+11-3
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,19 @@ const buildSourceLinkUrl = (componentName) =>
1818

1919
type Props = {|
2020
badge?: 'pilot' | 'deprecated',
21-
// DEPRECATED: Use `children` instead of `defaultCode`
21+
/**
22+
* @deprecated : Use `children` instead of `defaultCode`
23+
*/
2224
defaultCode?: string,
2325
description?: string,
24-
fileName?: string, // only use if name !== file name
25-
folderName?: string, // only use if name !== file name and the link should point to a directory
26+
/**
27+
* Only use if name !== file name
28+
*/
29+
fileName?: string,
30+
/**
31+
* Only use if name !== file name and the link should point to a directory
32+
*/
33+
folderName?: string,
2634
showCode?: boolean,
2735
name: string,
2836
margin?: 'default' | 'none',

0 commit comments

Comments
 (0)