[DataGrid] Remove unnecessary syntax in JSDoc (#10567)

Co-authored-by: Lev Shapiro <[email protected]> Co-authored-by: Olivier Tassinari <[email protected]>
mui · Oct 11, 2023 · 87815c0 · 87815c0
1 parent 2d567f6
commit 87815c0
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 12 deletions.
diff --git a/docs/pages/x/api/data-grid/data-grid-premium.json b/docs/pages/x/api/data-grid/data-grid-premium.json
@@ -608,7 +608,7 @@
         "name": "union",
         "description": "{ clipboardExport?: bool, csvExport?: bool }<br>&#124;&nbsp;bool"
       },
-      "default": ": false"
+      "default": "false"
     },
     "unstable_onCellSelectionModelChange": {
       "type": { "name": "func" },

diff --git a/docs/pages/x/api/data-grid/data-grid-pro.json b/docs/pages/x/api/data-grid/data-grid-pro.json
@@ -557,7 +557,7 @@
         "name": "union",
         "description": "{ clipboardExport?: bool, csvExport?: bool }<br>&#124;&nbsp;bool"
       },
-      "default": ": false"
+      "default": "false"
     }
   },
   "slots": [

diff --git a/docs/pages/x/api/data-grid/data-grid.json b/docs/pages/x/api/data-grid/data-grid.json
@@ -429,7 +429,7 @@
         "name": "union",
         "description": "{ clipboardExport?: bool, csvExport?: bool }<br>&#124;&nbsp;bool"
       },
-      "default": ": false"
+      "default": "false"
     }
   },
   "slots": [

diff --git a/packages/grid/x-data-grid-generator/src/services/tree-data-generator.ts b/packages/grid/x-data-grid-generator/src/services/tree-data-generator.ts
@@ -11,13 +11,12 @@ export interface AddPathToDemoDataOptions {
 
   /**
    * The depth of the tree
-   * @default: 1
+   * @default 1
    */
   maxDepth?: number;
-
   /**
    * The average amount of children in a node
-   * @default: 2
+   * @default 2
    */
   averageChildren?: number;
 }

diff --git a/packages/grid/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx b/packages/grid/x-data-grid-premium/src/DataGridPremium/DataGridPremium.tsx
@@ -1015,7 +1015,7 @@ DataGridPremiumRaw.propTypes = {
   /**
    * If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard.
    * If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export.
-   * @default: false
+   * @default false
    */
   unstable_ignoreValueFormatterDuringExport: PropTypes.oneOfType([
     PropTypes.shape({

diff --git a/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx b/packages/grid/x-data-grid-pro/src/DataGridPro/DataGridPro.tsx
@@ -931,7 +931,7 @@ DataGridProRaw.propTypes = {
   /**
    * If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard.
    * If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export.
-   * @default: false
+   * @default false
    */
   unstable_ignoreValueFormatterDuringExport: PropTypes.oneOfType([
     PropTypes.shape({

diff --git a/packages/grid/x-data-grid-pro/src/models/gridGroupingColDefOverride.ts b/packages/grid/x-data-grid-pro/src/models/gridGroupingColDefOverride.ts
@@ -15,7 +15,7 @@ export interface GridGroupingColDefOverride<R extends GridValidRowModel = any>
    * The field from which we want to apply the sorting and the filtering for the grouping column.
    * It is only useful when `props.rowGroupingColumnMode === "multiple"` to decide which grouping criteria should be used for sorting and filtering.
    * Do not have any effect when building the tree with the `props.treeData` feature.
-   * @default: The sorting and filtering is applied based on the leaf field in any, otherwise based on top level grouping criteria.
+   * @default The sorting and filtering is applied based on the leaf field in any, otherwise based on top level grouping criteria.
    */
   mainGroupingCriteria?: string;
 
@@ -27,7 +27,7 @@ export interface GridGroupingColDefOverride<R extends GridValidRowModel = any>
 
   /**
    * If `true`, the grouping cells will not render the amount of descendants.
-   * @default: false
+   * @default false
    */
   hideDescendantCount?: boolean;
 }

diff --git a/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx b/packages/grid/x-data-grid/src/DataGrid/DataGrid.tsx
@@ -712,7 +712,7 @@ DataGridRaw.propTypes = {
   /**
    * If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard.
    * If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export.
-   * @default: false
+   * @default false
    */
   unstable_ignoreValueFormatterDuringExport: PropTypes.oneOfType([
     PropTypes.shape({

diff --git a/packages/grid/x-data-grid/src/models/props/DataGridProps.ts b/packages/grid/x-data-grid/src/models/props/DataGridProps.ts
@@ -358,7 +358,7 @@ export interface DataGridPropsWithDefaultValues {
   /**
    * If `true`, the grid will not use `valueFormatter` when exporting to CSV or copying to clipboard.
    * If an object is provided, you can choose to ignore the `valueFormatter` for CSV export or clipboard export.
-   * @default: false
+   * @default false
    */
   unstable_ignoreValueFormatterDuringExport:
     | boolean