fix: class level seealso leaked to members (dotnet#9491)

* fix: class level seealso leaked to members * test(snapshot): update snapshots f845ba5 for ubuntu-latest * test(snapshot): update snapshots f845ba5 for windows-latest --------- Co-authored-by: yufeih <[email protected]>
ErpNetDocs · Jun 28, 2024 · 1fca121 · 1fca121
1 parent dc83dcf
commit 1fca121
Show file tree

Hide file tree

Showing 253 changed files with 7,962 additions and 4,395 deletions.
diff --git a/samples/seed/dotnet/project/Project/Class1.cs b/samples/seed/dotnet/project/Project/Class1.cs
@@ -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() {}
+}
diff --git a/templates/common/ManagedReference.common.js b/templates/common/ManagedReference.common.js
@@ -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

diff --git a/...SamplesTest.CSharp.Linux/api/CSharp10.ConstantInterpolatedStrings.html.view.verified.json b/...SamplesTest.CSharp.Linux/api/CSharp10.ConstantInterpolatedStrings.html.view.verified.json
@@ -184,7 +184,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ConstantInterpolatedStrings_S1",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -318,7 +318,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ConstantInterpolatedStrings_S2",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -452,7 +452,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ConstantInterpolatedStrings_S3",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -1090,7 +1090,7 @@
   "conceptual": "",
   "implements": "",
   "example": "",
-  "seealso": null,
+  "seealso": [],
   "id": "CSharp10_ConstantInterpolatedStrings",
   "hideTitleType": false,
   "hideSubtitle": false,

diff --git a/...fx.Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.Issue7737.html.view.verified.json b/...fx.Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.Issue7737.html.view.verified.json
@@ -182,7 +182,7 @@
           "remarks": "",
           "conceptual": "",
           "implements": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_Issue7737_Foo",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -820,7 +820,7 @@
   "conceptual": "",
   "implements": "",
   "example": "",
-  "seealso": null,
+  "seealso": [],
   "id": "CSharp10_Issue7737",
   "hideTitleType": false,
   "hideSubtitle": false,

diff --git a/...lesTest.CSharp.Linux/api/CSharp10.ParameterlessStructConstructors.html.view.verified.json b/...lesTest.CSharp.Linux/api/CSharp10.ParameterlessStructConstructors.html.view.verified.json
@@ -182,7 +182,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ParameterlessStructConstructors__ctor",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -323,7 +323,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ParameterlessStructConstructors_X",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -509,7 +509,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ParameterlessStructConstructors_Description",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -688,7 +688,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ParameterlessStructConstructors_Y",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -1225,7 +1225,7 @@
   "conceptual": "",
   "implements": "",
   "example": "",
-  "seealso": null,
+  "seealso": [],
   "id": "CSharp10_ParameterlessStructConstructors",
   "hideTitleType": false,
   "hideSubtitle": false,

diff --git a/....Tests/SamplesTest.CSharp.Linux/api/CSharp10.ReadOnlyRecordStruct.html.view.verified.json b/....Tests/SamplesTest.CSharp.Linux/api/CSharp10.ReadOnlyRecordStruct.html.view.verified.json
@@ -322,7 +322,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ReadOnlyRecordStruct__ctor_System_Double_System_Double_System_Double_",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -508,7 +508,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ReadOnlyRecordStruct_X",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -687,7 +687,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ReadOnlyRecordStruct_Y",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -866,7 +866,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ReadOnlyRecordStruct_Z",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -1448,7 +1448,7 @@
   "remarks": "",
   "conceptual": "",
   "example": "",
-  "seealso": null,
+  "seealso": [],
   "id": "CSharp10_ReadOnlyRecordStruct",
   "hideTitleType": false,
   "hideSubtitle": false,

diff --git a/....Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.RecordClass.html.view.verified.json b/....Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.RecordClass.html.view.verified.json
@@ -276,7 +276,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_RecordClass__ctor_System_String_System_String_",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -462,7 +462,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_RecordClass_FirstName",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -641,7 +641,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_RecordClass_LastName",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -1324,7 +1324,7 @@
   "remarks": "",
   "conceptual": "",
   "example": "",
-  "seealso": null,
+  "seealso": [],
   "id": "CSharp10_RecordClass",
   "hideTitleType": false,
   "hideSubtitle": false,

diff --git a/...Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.RecordStruct.html.view.verified.json b/...Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.RecordStruct.html.view.verified.json
@@ -276,7 +276,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_RecordStruct__ctor_System_DateTime_System_Double_",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -462,7 +462,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_RecordStruct_Measurement",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -641,7 +641,7 @@
           "conceptual": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_RecordStruct_TakenAt",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -1223,7 +1223,7 @@
   "remarks": "",
   "conceptual": "",
   "example": "",
-  "seealso": null,
+  "seealso": [],
   "id": "CSharp10_RecordStruct",
   "hideTitleType": false,
   "hideSubtitle": false,

diff --git a/test/docfx.Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.html.view.verified.json b/test/docfx.Snapshot.Tests/SamplesTest.CSharp.Linux/api/CSharp10.html.view.verified.json
@@ -64,7 +64,7 @@
           "syntax": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ConstantInterpolatedStrings",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -125,7 +125,7 @@
           "syntax": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_Issue7737",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -186,7 +186,7 @@
           "syntax": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_RecordClass",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -254,7 +254,7 @@
           "syntax": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ParameterlessStructConstructors",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -315,7 +315,7 @@
           "syntax": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_ReadOnlyRecordStruct",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -376,7 +376,7 @@
           "syntax": "",
           "implements": "",
           "example": "",
-          "seealso": null,
+          "seealso": [],
           "id": "CSharp10_RecordStruct",
           "hideTitleType": false,
           "hideSubtitle": false
@@ -548,7 +548,7 @@
   "syntax": "",
   "implements": "",
   "example": "",
-  "seealso": null,
+  "seealso": [],
   "id": "CSharp10",
   "hideTitleType": false,
   "hideSubtitle": false,