Skip to content

Commit aee0a32

Browse files
authored
[tools] (YML) Expand type aliases to include links (#2249)
* Testing link syntax * Testing link syntax * Testing postprocessor changes * Rerunning full suite * Rerunning full suite * Retain schema comment * Fix link syntax * Fix regex matching for links * Switch to markdown links * Special case Office type aliases * Fix host links for old versions * Fix host links for old versions * Rerun whole suite * Fix capitalization
1 parent fa37bf2 commit aee0a32

File tree

23,027 files changed

+1654594
-888405
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

23,027 files changed

+1654594
-888405
lines changed

docs/docs-ref-autogen/common/toc.yml

Lines changed: 117 additions & 117 deletions
Large diffs are not rendered by default.

docs/docs-ref-autogen/common_preview/toc.yml

Lines changed: 118 additions & 118 deletions
Large diffs are not rendered by default.

docs/docs-ref-autogen/excel/custom-functions-runtime.yml

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,22 @@ name: custom-functions-runtime
44
type: package
55
summary: ''
66
interfaces:
7-
- 'custom-functions-runtime!CustomFunctions.CancelableInvocation:interface'
8-
- 'custom-functions-runtime!CustomFunctions.Invocation:interface'
9-
- 'custom-functions-runtime!CustomFunctions.StreamingInvocation:interface'
7+
- custom-functions-runtime!CustomFunctions.CancelableInvocation:interface
8+
- custom-functions-runtime!CustomFunctions.Invocation:interface
9+
- custom-functions-runtime!CustomFunctions.StreamingInvocation:interface
1010
classes:
11-
- 'custom-functions-runtime!CustomFunctions.Error:class'
11+
- custom-functions-runtime!CustomFunctions.Error:class
1212
enums:
13-
- 'custom-functions-runtime!CustomFunctions.ErrorCode:enum'
13+
- custom-functions-runtime!CustomFunctions.ErrorCode:enum
1414
functions:
15-
- name: 'CustomFunctions.associate(id, functionObject)'
16-
uid: 'custom-functions-runtime!CustomFunctions.associate:function(1)'
15+
- name: CustomFunctions.associate(id, functionObject)
16+
uid: custom-functions-runtime!CustomFunctions.associate:function(1)
1717
package: custom-functions-runtime!
18-
summary: Associates the JavaScript function to the name given by the "id" property in the metadata JSON file.
18+
summary: >-
19+
Associates the JavaScript function to the name given by the "id" property
20+
in the metadata JSON file.
1921
remarks: ''
22+
2023
isPreview: false
2124
isDeprecated: false
2225
syntax:
@@ -32,10 +35,13 @@ functions:
3235
type: void
3336
description: ''
3437
- name: CustomFunctions.associate(mappings)
35-
uid: 'custom-functions-runtime!CustomFunctions.associate:function(2)'
38+
uid: custom-functions-runtime!CustomFunctions.associate:function(2)
3639
package: custom-functions-runtime!
37-
summary: Associates the JavaScript functions to the names given by the "id" properties in the metadata JSON file.
40+
summary: >-
41+
Associates the JavaScript functions to the names given by the "id"
42+
properties in the metadata JSON file.
3843
remarks: ''
44+
3945
isPreview: false
4046
isDeprecated: false
4147
syntax:
Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,40 @@
11
### YamlMime:TSType
22
name: CustomFunctions.CancelableInvocation
3-
uid: 'custom-functions-runtime!CustomFunctions.CancelableInvocation:interface'
3+
uid: custom-functions-runtime!CustomFunctions.CancelableInvocation:interface
44
package: custom-functions-runtime!
55
fullName: CustomFunctions.CancelableInvocation
66
summary: >-
7-
Provides information about the invocation of a cancelable custom function. A cancelable custom function can provide a
8-
handler for the onCanceled event.
7+
Provides information about the invocation of a cancelable custom function. A
8+
cancelable custom function can provide a handler for the onCanceled event.
99
1010
11-
To indicate that a function is cancelable, in the metadata JSON file, the function options should specify: `{
12-
"cancelable": true }`
11+
To indicate that a function is cancelable, in the metadata JSON file, the
12+
function options should specify: `{ "cancelable": true }`
1313
1414
15-
If the metadata JSON file is being generated from JSDoc comments, include the tag `@cancelable`<!-- -->.
15+
If the metadata JSON file is being generated from JSDoc comments, include the
16+
tag `@cancelable`<!-- -->.
1617
remarks: ''
18+
1719
isPreview: false
1820
isDeprecated: false
1921
type: interface
2022
events:
2123
- name: onCanceled
22-
uid: 'custom-functions-runtime!CustomFunctions.CancelableInvocation#onCanceled:member'
24+
uid: >-
25+
custom-functions-runtime!CustomFunctions.CancelableInvocation#onCanceled:member
2326
package: custom-functions-runtime!
2427
fullName: onCanceled
2528
summary: Event handler called when the custom function is canceled.
26-
remarks: '\[ [API set: CustomFunctionsRuntime 1.1](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) \]'
29+
remarks: >-
30+
\[ [API set: CustomFunctionsRuntime
31+
1.1](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets)
32+
\]
33+
2734
isPreview: false
2835
isDeprecated: false
2936
syntax:
3037
content: 'onCanceled?: () => void;'
3138
return:
3239
type: () =&gt; void
33-
extends: '<xref uid="custom-functions-runtime!CustomFunctions.Invocation:interface" />'
40+
extends: <xref uid="custom-functions-runtime!CustomFunctions.Invocation:interface" />

docs/docs-ref-autogen/excel/custom-functions-runtime/customfunctions.error.yml

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
### YamlMime:TSType
22
name: CustomFunctions.Error
3-
uid: 'custom-functions-runtime!CustomFunctions.Error:class'
3+
uid: custom-functions-runtime!CustomFunctions.Error:class
44
package: custom-functions-runtime!
55
fullName: CustomFunctions.Error
66
summary: Use this class to handle errors and write custom error messages.
7-
remarks: |-
8-
\[ [API set: CustomFunctionsRuntime 1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) \]
7+
remarks: >-
8+
\[ [API set: CustomFunctionsRuntime
9+
1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets)
10+
\]
11+
912
1013
#### Examples
1114
15+
1216
```TypeScript
17+
1318
/**
1419
* Returns the #NUM! error as part of a 2-dimensional array.
1520
* @customfunction
@@ -34,49 +39,62 @@ remarks: |-
3439
// and a #NUM! error in place of the second result.
3540
return [[firstResult], [secondResult], [thirdResult]];
3641
};
42+
3743
```
44+
3845
isPreview: false
3946
isDeprecated: false
4047
type: class
4148
constructors:
42-
- name: '(constructor)(code, message)'
43-
uid: 'custom-functions-runtime!CustomFunctions.Error:constructor(1)'
49+
- name: (constructor)(code, message)
50+
uid: custom-functions-runtime!CustomFunctions.Error:constructor(1)
4451
package: custom-functions-runtime!
45-
fullName: '(constructor)(code, message)'
52+
fullName: (constructor)(code, message)
4653
summary: Constructs a new instance of the `Error` class
4754
remarks: ''
55+
4856
isPreview: false
4957
isDeprecated: false
5058
syntax:
5159
content: 'constructor(code: ErrorCode, message?: string);'
5260
parameters:
5361
- id: code
5462
description: ''
55-
type: '<xref uid="custom-functions-runtime!CustomFunctions.ErrorCode:enum" />'
63+
type: >-
64+
<xref uid="custom-functions-runtime!CustomFunctions.ErrorCode:enum"
65+
/>
5666
- id: message
5767
description: ''
5868
type: string
5969
properties:
6070
- name: code
61-
uid: 'custom-functions-runtime!CustomFunctions.Error#code:member'
71+
uid: custom-functions-runtime!CustomFunctions.Error#code:member
6272
package: custom-functions-runtime!
6373
fullName: code
6474
summary: The error code returned by your custom function.
65-
remarks: '\[ [API set: CustomFunctionsRuntime 1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) \]'
75+
remarks: >-
76+
\[ [API set: CustomFunctionsRuntime
77+
1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets)
78+
\]
79+
6680
isPreview: false
6781
isDeprecated: false
6882
syntax:
6983
content: 'code: ErrorCode;'
7084
return:
71-
type: '<xref uid="custom-functions-runtime!CustomFunctions.ErrorCode:enum" />'
85+
type: <xref uid="custom-functions-runtime!CustomFunctions.ErrorCode:enum" />
7286
- name: message
73-
uid: 'custom-functions-runtime!CustomFunctions.Error#message:member'
87+
uid: custom-functions-runtime!CustomFunctions.Error#message:member
7488
package: custom-functions-runtime!
7589
fullName: message
7690
summary: >-
77-
Your custom error message, such as "This stock price is unavailable". Custom messages are only available with
78-
certain error codes.
79-
remarks: '\[ [API set: CustomFunctionsRuntime 1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets) \]'
91+
Your custom error message, such as "This stock price is unavailable".
92+
Custom messages are only available with certain error codes.
93+
remarks: >-
94+
\[ [API set: CustomFunctionsRuntime
95+
1.2](/javascript/api/requirement-sets/excel/custom-functions-requirement-sets)
96+
\]
97+
8098
isPreview: false
8199
isDeprecated: false
82100
syntax:
Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
### YamlMime:TSEnum
22
name: CustomFunctions.ErrorCode
3-
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode:enum'
3+
uid: custom-functions-runtime!CustomFunctions.ErrorCode:enum
44
package: custom-functions-runtime!
55
fullName: CustomFunctions.ErrorCode
66
summary: >-
7-
Error codes for custom functions. The error codes will appear in the cell that invoked the function.
7+
Error codes for custom functions. The error codes will appear in the cell that
8+
invoked the function.
89
910
10-
Custom error messages appear in addition to these error codes. Custom messages display in the error indicator menu,
11-
which is accessed by hovering over the error flag on each cell with an error.
11+
Custom error messages appear in addition to these error codes. Custom messages
12+
display in the error indicator menu, which is accessed by hovering over the
13+
error flag on each cell with an error.
1214
remarks: |-
1315
1416
@@ -40,53 +42,62 @@ remarks: |-
4042
return [[firstResult], [secondResult], [thirdResult]];
4143
};
4244
```
45+
4346
isPreview: false
4447
isDeprecated: false
4548
fields:
4649
- name: divisionByZero
47-
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.divisionByZero:member'
50+
uid: custom-functions-runtime!CustomFunctions.ErrorCode.divisionByZero:member
4851
package: custom-functions-runtime!
4952
summary: >-
50-
This error code indicates that the function used is dividing by zero or empty cells. A custom error message can't
51-
be used.
53+
This error code indicates that the function used is dividing by zero or
54+
empty cells. A custom error message can't be used.
5255
value: '"#DIV/0!"'
5356
- name: invalidName
54-
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.invalidName:member'
57+
uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidName:member
5558
package: custom-functions-runtime!
5659
summary: >-
57-
This error code indicates that there is a typo in the function name. Note that this error code is supported as a
58-
custom function input error, but not as a custom function output error. A custom error message can't be used.
60+
This error code indicates that there is a typo in the function name. Note
61+
that this error code is supported as a custom function input error, but
62+
not as a custom function output error. A custom error message can't be
63+
used.
5964
value: '"#NAME?"'
6065
- name: invalidNumber
61-
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.invalidNumber:member'
66+
uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidNumber:member
6267
package: custom-functions-runtime!
6368
summary: >-
64-
This error code indicates that there is a problem with a number in the function. A custom error message can't be
65-
used.
69+
This error code indicates that there is a problem with a number in the
70+
function. A custom error message can't be used.
6671
value: '"#NUM!"'
6772
- name: invalidReference
68-
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.invalidReference:member'
73+
uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidReference:member
6974
package: custom-functions-runtime!
7075
summary: >-
71-
This error code indicates that the function refers to an invalid cell. Note that this error code is supported as a
72-
custom function input error, but not as a custom function output error. A custom error message can't be used.
76+
This error code indicates that the function refers to an invalid cell.
77+
Note that this error code is supported as a custom function input error,
78+
but not as a custom function output error. A custom error message can't be
79+
used.
7380
value: '"#REF!"'
7481
- name: invalidValue
75-
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.invalidValue:member'
82+
uid: custom-functions-runtime!CustomFunctions.ErrorCode.invalidValue:member
7683
package: custom-functions-runtime!
7784
summary: >-
78-
This error code indicates that a value in the function is of the wrong data type. A custom error message can be
79-
used in addition to the error code, if desired.
85+
This error code indicates that a value in the function is of the wrong
86+
data type. A custom error message can be used in addition to the error
87+
code, if desired.
8088
value: '"#VALUE!"'
8189
- name: notAvailable
82-
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.notAvailable:member'
90+
uid: custom-functions-runtime!CustomFunctions.ErrorCode.notAvailable:member
8391
package: custom-functions-runtime!
8492
summary: >-
85-
This error code indicates that the function or service isn't available. A custom error message can be used in
86-
addition to the error code, if desired.
93+
This error code indicates that the function or service isn't available. A
94+
custom error message can be used in addition to the error code, if
95+
desired.
8796
value: '"#N/A"'
8897
- name: nullReference
89-
uid: 'custom-functions-runtime!CustomFunctions.ErrorCode.nullReference:member'
98+
uid: custom-functions-runtime!CustomFunctions.ErrorCode.nullReference:member
9099
package: custom-functions-runtime!
91-
summary: This error code indicates that the ranges in the function don't intersect. A custom error message can't be used.
100+
summary: >-
101+
This error code indicates that the ranges in the function don't intersect.
102+
A custom error message can't be used.
92103
value: '"#NULL!"'

0 commit comments

Comments
 (0)