Internal: use multiline comments to enable flow docs (#2383)

pinterest · Sep 12, 2022 · 0881e35 · 0881e35
1 parent e974221
commit 0881e35
Showing 1 changed file with 11 additions and 3 deletions.
diff --git a/docs/docs-components/PageHeader.js b/docs/docs-components/PageHeader.js
@@ -18,11 +18,19 @@ const buildSourceLinkUrl = (componentName) =>
 
 type Props = {|
   badge?: 'pilot' | 'deprecated',
-  // DEPRECATED: Use `children` instead of `defaultCode`
+  /**
+   * @deprecated : Use `children` instead of `defaultCode`
+   */
   defaultCode?: string,
   description?: string,
-  fileName?: string, // only use if name !== file name
-  folderName?: string, // only use if name !== file name and the link should point to a directory
+  /**
+   * Only use if name !== file name
+   */
+  fileName?: string,
+  /**
+   * Only use if name !== file name and the link should point to a directory
+   */
+  folderName?: string,
   showCode?: boolean,
   name: string,
   margin?: 'default' | 'none',