Skip to content

Commit ed71171

Browse files
committed
Add test case for links to function overloads
1 parent 572c96b commit ed71171

File tree

4 files changed

+14
-5
lines changed

4 files changed

+14
-5
lines changed

build-tests/api-documenter-test/etc/api-documenter-test.api.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@
9999
{
100100
"kind": "Class",
101101
"canonicalReference": "api-documenter-test!DocClass1:class",
102-
"docComment": "/**\n * This is an example class.\n *\n * @remarks\n *\n * These are some remarks.\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `DocClass1` class.\n *\n * @defaultValue\n *\n * a default value for this function\n *\n * {@docCategory DocClass1}\n *\n * @public\n */\n",
102+
"docComment": "/**\n * This is an example class.\n *\n * @remarks\n *\n * {@link DocClass1.(exampleFunction:1) | Link to overload 1}\n *\n * {@link DocClass1.(exampleFunction:2) | Link to overload 2}\n *\n * {@docCategory DocClass1}\n *\n * The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `DocClass1` class.\n *\n * @public\n */\n",
103103
"excerptTokens": [
104104
{
105105
"kind": "Content",

build-tests/api-documenter-test/etc/markdown/api-documenter-test.docclass1.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ export declare class DocClass1 extends DocBaseClass implements IDocInterface1, I
1414
1515
## Remarks
1616
17-
These are some remarks.
17+
[Link to overload 1](./api-documenter-test.docclass1.examplefunction.md)
18+
19+
[Link to overload 2](./api-documenter-test.docclass1.examplefunction_1.md)
20+
1821
1922
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `DocClass1` class.
2023

build-tests/api-documenter-test/etc/yaml/api-documenter-test/docclass1.yml

+5-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@ items:
33
- uid: 'api-documenter-test!DocClass1:class'
44
summary: This is an example class.
55
remarks: >-
6-
These are some remarks.
6+
[Link to overload 1](xref:api-documenter-test!DocClass1#exampleFunction:member(1))
7+
8+
9+
[Link to overload 2](xref:api-documenter-test!DocClass1#exampleFunction:member(2))
10+
711
812
913
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or

build-tests/api-documenter-test/src/DocClass1.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,10 @@ export interface IDocInterface4 {
140140
* This is an example class.
141141
*
142142
* @remarks
143-
* These are some remarks.
144-
* @defaultValue a default value for this function
143+
* {@link DocClass1.(exampleFunction:1)|Link to overload 1}
144+
*
145+
* {@link DocClass1.(exampleFunction:2)|Link to overload 2}
146+
*
145147
* @public
146148
* {@docCategory DocClass1}
147149
*/

0 commit comments

Comments
 (0)