Update reference docs with latest IntelliSense file (#354)

AlexJerabek · web-flow · commit 58906f9a0e14 · 2024-07-10T13:04:06.000-07:00
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartpoint.yml
@@ -78,7 +78,9 @@ methods:
     uid: 'ExcelScript!ExcelScript.ChartPoint#getMarkerSize:member(1)'
     package: ExcelScript!
     fullName: getMarkerSize()
-    summary: Represents marker size of a data point.
+    summary: >-
+      Represents marker size of a data point. The supported size range is 2 to 72. This method returns an
+      InvalidArgument error if it's set with a size outside of the supported range.
     remarks: ''
     isPreview: false
     isDeprecated: false
@@ -168,7 +170,9 @@ methods:
     uid: 'ExcelScript!ExcelScript.ChartPoint#setMarkerSize:member(1)'
     package: ExcelScript!
     fullName: setMarkerSize(markerSize)
-    summary: Represents marker size of a data point.
+    summary: >-
+      Represents marker size of a data point. The supported size range is 2 to 72. This method returns an
+      InvalidArgument error if it's set with a size outside of the supported range.
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.chartseries.yml
@@ -525,7 +525,9 @@ methods:
     uid: 'ExcelScript!ExcelScript.ChartSeries#getMarkerSize:member(1)'
     package: ExcelScript!
     fullName: getMarkerSize()
-    summary: Specifies the marker size of a chart series.
+    summary: >-
+      Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an
+      InvalidArgument error if it's set with a size outside of the supported range.
     remarks: ''
     isPreview: false
     isDeprecated: false
@@ -1236,7 +1238,9 @@ methods:
     uid: 'ExcelScript!ExcelScript.ChartSeries#setMarkerSize:member(1)'
     package: ExcelScript!
     fullName: setMarkerSize(markerSize)
-    summary: Specifies the marker size of a chart series.
+    summary: >-
+      Specifies the marker size of a chart series. The supported size range is 2 to 72. This method returns an
+      InvalidArgument error if it's set with a size outside of the supported range.
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.datavalidation.yml
@@ -54,7 +54,7 @@ methods:
     fullName: getInvalidCells()
     summary: >-
       Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell
-      values are valid, this method returns `null`<!-- -->.
+      values are valid, this function will return `null`<!-- -->.
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.pivotlabelfilter.yml
@@ -82,7 +82,7 @@ properties:
     uid: 'ExcelScript!ExcelScript.PivotLabelFilter#substring:member'
     package: ExcelScript!
     fullName: substring
-    summary: 'The substring used for `beginsWith`<!-- -->, `endsWith`<!-- -->, and `contains` filter conditions.'
+    summary: 'The substring used for the `beginsWith`<!-- -->, `endsWith`<!-- -->, and `contains` filter conditions.'
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.range.yml
@@ -1290,7 +1290,7 @@ methods:
     summary: >-
       Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count
       in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object
-      doesn't exist, then this method returns `undefined`<!-- -->.
+      doesn't exist, then this function returns `undefined`<!-- -->.
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.sortmethod.yml
@@ -3,7 +3,7 @@ name: ExcelScript.SortMethod
 uid: 'ExcelScript!ExcelScript.SortMethod:enum'
 package: ExcelScript!
 fullName: ExcelScript.SortMethod
-summary: ''
+summary: Represents the ordering method to be used when sorting Chinese characters.
 remarks: |-
 
 
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbook.yml
@@ -1614,7 +1614,7 @@ methods:
     uid: 'ExcelScript!ExcelScript.Workbook#refreshAllDataConnections:member(1)'
     package: ExcelScript!
     fullName: refreshAllDataConnections()
-    summary: Makes a request to refresh all the data connections.
+    summary: Refreshes all the Data Connections.
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.workbookprotection.yml
@@ -45,7 +45,7 @@ methods:
     uid: 'ExcelScript!ExcelScript.WorkbookProtection#protect:member(1)'
     package: ExcelScript!
     fullName: protect(password)
-    summary: Protects a workbook. Fails if the workbook has been protected.
+    summary: Protects the workbook. Fails if the workbook has been protected.
     remarks: ''
     isPreview: false
     isDeprecated: false
@@ -80,7 +80,7 @@ methods:
     uid: 'ExcelScript!ExcelScript.WorkbookProtection#unprotect:member(1)'
     package: ExcelScript!
     fullName: unprotect(password)
-    summary: Unprotects a workbook.
+    summary: Unprotects the workbook.
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml b/docs/docs-ref-autogen/excel/excelscript/excelscript.worksheet.yml
@@ -1067,7 +1067,7 @@ methods:
     uid: 'ExcelScript!ExcelScript.Worksheet#getName:member(1)'
     package: ExcelScript!
     fullName: getName()
-    summary: The display name of the worksheet.
+    summary: The display name of the worksheet. The name must be fewer than 32 characters.
     remarks: ''
     isPreview: false
     isDeprecated: false
@@ -1740,7 +1740,7 @@ methods:
     uid: 'ExcelScript!ExcelScript.Worksheet#setName:member(1)'
     package: ExcelScript!
     fullName: setName(name)
-    summary: The display name of the worksheet.
+    summary: The display name of the worksheet. The name must be fewer than 32 characters.
     remarks: ''
     isPreview: false
     isDeprecated: false
diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv
@@ -2925,7 +2925,7 @@ ExcelScript.SortField,"icon",Property,Fine,false
 ExcelScript.SortField,"key",Property,Good,true
 ExcelScript.SortField,"sortOn",Property,Fine,false
 ExcelScript.SortField,"subField",Property,Fine,false
-ExcelScript.SortMethod,N/A,Enum,Missing,true
+ExcelScript.SortMethod,N/A,Enum,Fine,true
 ExcelScript.SortMethod,"pinYin",EnumField,Missing,false
 ExcelScript.SortMethod,"strokeCount",EnumField,Missing,false
 ExcelScript.SortOn,N/A,Enum,Fine,true
@@ -3246,7 +3246,7 @@ ExcelScript.Worksheet,"getEnableCalculation()",Method,Poor,false
 ExcelScript.Worksheet,"getFreezePanes()",Method,Poor,false
 ExcelScript.Worksheet,"getHorizontalPageBreaks()",Method,Poor,false
 ExcelScript.Worksheet,"getId()",Method,Poor,false
-ExcelScript.Worksheet,"getName()",Method,Poor,true
+ExcelScript.Worksheet,"getName()",Method,Fine,true
 ExcelScript.Worksheet,"getNamedItem(name)",Method,Poor,false
 ExcelScript.Worksheet,"getNamedSheetView(key)",Method,Poor,false
 ExcelScript.Worksheet,"getNamedSheetViews()",Method,Poor,false
diff --git a/generate-docs/api-extractor-inputs-excel/excel.d.ts b/generate-docs/api-extractor-inputs-excel/excel.d.ts
@@ -746,7 +746,7 @@ export declare namespace ExcelScript {
         getLastWorksheet(visibleOnly?: boolean): Worksheet;
 
         /**
-         * Makes a request to refresh all the data connections.
+         * Refreshes all the Data Connections.
          */
         refreshAllDataConnections(): void;
 
@@ -768,13 +768,13 @@ export declare namespace ExcelScript {
         getProtected(): boolean;
 
         /**
-         * Protects a workbook. Fails if the workbook has been protected.
+         * Protects the workbook. Fails if the workbook has been protected.
          * @param password - Workbook protection password.
          */
         protect(password?: string): void;
 
         /**
-         * Unprotects a workbook.
+         * Unprotects the workbook.
          * @param password - Workbook protection password.
          */
         unprotect(password?: string): void;
@@ -812,12 +812,12 @@ export declare namespace ExcelScript {
         getId(): string;
 
         /**
-         * The display name of the worksheet.
+         * The display name of the worksheet. The name must be fewer than 32 characters.
          */
         getName(): string;
 
         /**
-         * The display name of the worksheet.
+         * The display name of the worksheet. The name must be fewer than 32 characters.
          */
         setName(name: string): void;
 
@@ -1869,7 +1869,7 @@ export declare namespace ExcelScript {
         getLastRow(): Range;
 
         /**
-         * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this method returns `undefined`.
+         * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this function returns `undefined`.
          */
         getMergedAreas(): RangeAreas;
 
@@ -2947,7 +2947,7 @@ export declare namespace ExcelScript {
         clear(): void;
 
         /**
-         * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this method returns `null`.
+         * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this function will return `null`.
          */
         getInvalidCells(): RangeAreas;
     }
@@ -4028,11 +4028,13 @@ export declare namespace ExcelScript {
 
         /**
          * Specifies the marker size of a chart series.
+         * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
          */
         getMarkerSize(): number;
 
         /**
          * Specifies the marker size of a chart series.
+         * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
          */
         setMarkerSize(markerSize: number): void;
 
@@ -4305,11 +4307,13 @@ export declare namespace ExcelScript {
 
         /**
          * Represents marker size of a data point.
+         * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
          */
         getMarkerSize(): number;
 
         /**
          * Represents marker size of a data point.
+         * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
          */
         setMarkerSize(markerSize: number): void;
 
@@ -10185,7 +10189,7 @@ export declare namespace ExcelScript {
         lowerBound?: string;
 
         /**
-         * The substring used for `beginsWith`, `endsWith`, and `contains` filter conditions.
+         * The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions.
          */
         substring?: string;
 
@@ -13472,6 +13476,9 @@ export declare namespace ExcelScript {
         textAsNumber,
     }
 
+    /**
+     * Represents the ordering method to be used when sorting Chinese characters.
+     */
     enum SortMethod {
         pinYin,
 
diff --git a/generate-docs/script-inputs/excel.d.ts b/generate-docs/script-inputs/excel.d.ts
@@ -746,7 +746,7 @@ declare namespace ExcelScript {
         getLastWorksheet(visibleOnly?: boolean): Worksheet;
 
         /**
-         * Makes a request to refresh all the data connections.
+         * Refreshes all the Data Connections.
          */
         refreshAllDataConnections(): void;
 
@@ -768,13 +768,13 @@ declare namespace ExcelScript {
         getProtected(): boolean;
 
         /**
-         * Protects a workbook. Fails if the workbook has been protected.
+         * Protects the workbook. Fails if the workbook has been protected.
          * @param password Workbook protection password.
          */
         protect(password?: string): void;
 
         /**
-         * Unprotects a workbook.
+         * Unprotects the workbook.
          * @param password Workbook protection password.
          */
         unprotect(password?: string): void;
@@ -812,12 +812,12 @@ declare namespace ExcelScript {
         getId(): string;
 
         /**
-         * The display name of the worksheet.
+         * The display name of the worksheet. The name must be fewer than 32 characters.
          */
         getName(): string;
 
         /**
-         * The display name of the worksheet.
+         * The display name of the worksheet. The name must be fewer than 32 characters.
          */
         setName(name: string): void;
 
@@ -1869,7 +1869,7 @@ declare namespace ExcelScript {
         getLastRow(): Range;
 
         /**
-         * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this method returns `undefined`.
+         * Returns a `RangeAreas` object that represents the merged areas in this range. Note that if the merged areas count in this range is more than 512, then this method will fail to return the result. If the `RangeAreas` object doesn't exist, then this function returns `undefined`.
          */
         getMergedAreas(): RangeAreas;
 
@@ -2947,7 +2947,7 @@ declare namespace ExcelScript {
         clear(): void;
 
         /**
-         * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this method returns `null`.
+         * Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values. If all cell values are valid, this function will return `null`.
          */
         getInvalidCells(): RangeAreas;
     }
@@ -4028,11 +4028,13 @@ declare namespace ExcelScript {
 
         /**
          * Specifies the marker size of a chart series.
+         * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
          */
         getMarkerSize(): number;
 
         /**
          * Specifies the marker size of a chart series.
+         * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
          */
         setMarkerSize(markerSize: number): void;
 
@@ -4305,11 +4307,13 @@ declare namespace ExcelScript {
 
         /**
          * Represents marker size of a data point.
+         * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
          */
         getMarkerSize(): number;
 
         /**
          * Represents marker size of a data point.
+         * The supported size range is 2 to 72. This method returns an InvalidArgument error if it's set with a size outside of the supported range.
          */
         setMarkerSize(markerSize: number): void;
 
@@ -10185,7 +10189,7 @@ declare namespace ExcelScript {
         lowerBound?: string;
 
         /**
-         * The substring used for `beginsWith`, `endsWith`, and `contains` filter conditions.
+         * The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions.
          */
         substring?: string;
 
@@ -13472,6 +13476,9 @@ declare namespace ExcelScript {
         textAsNumber,
     }
 
+    /**
+     * Represents the ordering method to be used when sorting Chinese characters.
+     */
     enum SortMethod {
         pinYin,
 
