Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: class level seealso leaked to members #9491

Merged
merged 3 commits into from
Nov 29, 2023
Merged

fix: class level seealso leaked to members #9491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
15f09c8
fix: class level seealso leaked to members
yufeih Nov 29, 2023
a83ed22
test(snapshot): update snapshots f845ba59dbd35c2dcd78a803c96f27a6fbf7…
yufeih Nov 29, 2023
ab0fc23
test(snapshot): update snapshots f845ba59dbd35c2dcd78a803c96f27a6fbf7…
yufeih Nov 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion samples/seed/dotnet/project/Project/Class1.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,4 +202,15 @@ public ExperimentalAttribute(string diagnosticId)

public string DiagnosticId { get; }
public string? UrlFormat { get; set; }
}
}

/// <summary>A nice class</summary>
/// <seealso cref="Class1"/>
public class Issue8725
{
/// <summary>A nice operation</summary>
public void MyOperation() {}

/// <summary>Another nice operation</summary>
public void MoreOperations() {}
}
1 change: 1 addition & 0 deletions templates/common/ManagedReference.common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ function handleItem(vm, gitContribute, gitUrlPattern) {
vm.syntax = vm.syntax || "";
vm.implements = vm.implements || "";
vm.example = vm.example || "";
vm.seealso = vm.seealso || [];
common.processSeeAlso(vm);

// id is used as default template's bookmark
Expand Down
8 changes: 4 additions & 4 deletions ...SamplesTest.CSharp.Linux/api/CSharp10.ConstantInterpolatedStrings.html.view.verified.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ConstantInterpolatedStrings_S1",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -318,7 +318,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ConstantInterpolatedStrings_S2",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -452,7 +452,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ConstantInterpolatedStrings_S3",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -1090,7 +1090,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ConstantInterpolatedStrings",
"hideTitleType": false,
"hideSubtitle": false,
Expand Down
4 changes: 2 additions & 2 deletions ...fx.Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.Issue7737.html.view.verified.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@
"remarks": "",
"conceptual": "",
"implements": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_Issue7737_Foo",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -820,7 +820,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_Issue7737",
"hideTitleType": false,
"hideSubtitle": false,
Expand Down
10 changes: 5 additions & 5 deletions ...lesTest.CSharp.Linux/api/CSharp10.ParameterlessStructConstructors.html.view.verified.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ParameterlessStructConstructors__ctor",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -323,7 +323,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ParameterlessStructConstructors_X",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -509,7 +509,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ParameterlessStructConstructors_Description",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -688,7 +688,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ParameterlessStructConstructors_Y",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -1225,7 +1225,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ParameterlessStructConstructors",
"hideTitleType": false,
"hideSubtitle": false,
Expand Down
10 changes: 5 additions & 5 deletions ....Tests/SamplesTest.CSharp.Linux/api/CSharp10.ReadOnlyRecordStruct.html.view.verified.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,7 +322,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ReadOnlyRecordStruct__ctor_System_Double_System_Double_System_Double_",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -508,7 +508,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ReadOnlyRecordStruct_X",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -687,7 +687,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ReadOnlyRecordStruct_Y",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -866,7 +866,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ReadOnlyRecordStruct_Z",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -1448,7 +1448,7 @@
"remarks": "",
"conceptual": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ReadOnlyRecordStruct",
"hideTitleType": false,
"hideSubtitle": false,
Expand Down
8 changes: 4 additions & 4 deletions ....Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.RecordClass.html.view.verified.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordClass__ctor_System_String_System_String_",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -462,7 +462,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordClass_FirstName",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -641,7 +641,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordClass_LastName",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -1324,7 +1324,7 @@
"remarks": "",
"conceptual": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordClass",
"hideTitleType": false,
"hideSubtitle": false,
Expand Down
8 changes: 4 additions & 4 deletions ...Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.RecordStruct.html.view.verified.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordStruct__ctor_System_DateTime_System_Double_",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -462,7 +462,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordStruct_Measurement",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -641,7 +641,7 @@
"conceptual": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordStruct_TakenAt",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -1223,7 +1223,7 @@
"remarks": "",
"conceptual": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordStruct",
"hideTitleType": false,
"hideSubtitle": false,
Expand Down
14 changes: 7 additions & 7 deletions test/docfx.Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.html.view.verified.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@
"syntax": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ConstantInterpolatedStrings",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -125,7 +125,7 @@
"syntax": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_Issue7737",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -186,7 +186,7 @@
"syntax": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordClass",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -254,7 +254,7 @@
"syntax": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ParameterlessStructConstructors",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -315,7 +315,7 @@
"syntax": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_ReadOnlyRecordStruct",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -376,7 +376,7 @@
"syntax": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10_RecordStruct",
"hideTitleType": false,
"hideSubtitle": false
Expand Down Expand Up @@ -548,7 +548,7 @@
"syntax": "",
"implements": "",
"example": "",
"seealso": null,
"seealso": [],
"id": "CSharp10",
"hideTitleType": false,
"hideSubtitle": false,
Expand Down
Loading
Loading