fix: mref mustach template description leak (#9632)

* fix: mref mustach template description leak * test(snapshot): update snapshots 09b47a9 for ubuntu-latest * test(snapshot): update snapshots 09b47a9 for windows-latest --------- Co-authored-by: yufeih <[email protected]>
dotnet · Jan 21, 2024 · ad6db16 · ad6db16
1 parent 0a5e666
commit ad6db16
Show file tree

Hide file tree

Showing 263 changed files with 8,487 additions and 3,387 deletions.
diff --git a/samples/seed/dotnet/project/Project/Class1.cs b/samples/seed/dotnet/project/Project/Class1.cs
@@ -214,3 +214,30 @@ public void MyOperation() {}
     /// <summary>Another nice operation</summary>
     public void MoreOperations() {}
 }
+
+/// <summary>
+/// Class representing a dog.
+/// </summary>
+public class Dog
+{
+    /// <summary>
+    /// Name of the dog.
+    /// </summary>
+    public string Name { get; }
+
+    /// <summary>
+    /// Age of the dog.
+    /// </summary>
+    public int Age { get; }
+
+    /// <summary>
+    /// Constructor.
+    /// </summary>
+    /// <param name="name">Name of the dog.</param>
+    /// <param name="age">Age of the dog.</param>
+    public Dog(string name, int age)
+    {
+        Name = name;
+        Age = age;
+    }
+}
diff --git a/templates/common/ManagedReference.common.js b/templates/common/ManagedReference.common.js
@@ -198,6 +198,7 @@ function handleItem(vm, gitContribute, gitUrlPattern) {
 
   // set to null incase mustache looks up
   vm.summary = vm.summary || "";
+  vm.description = vm.description || "";
   vm.remarks = vm.remarks || "";
   vm.conceptual = vm.conceptual || "";
   vm.syntax = vm.syntax || "";

diff --git a/...SamplesTest.CSharp.Linux/api/CSharp10.ConstantInterpolatedStrings.html.view.verified.json b/...SamplesTest.CSharp.Linux/api/CSharp10.ConstantInterpolatedStrings.html.view.verified.json
@@ -180,6 +180,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ConstantInterpolatedStrings_S1.md&value=---%0Auid%3A%20CSharp10.ConstantInterpolatedStrings.S1%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L23",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -314,6 +315,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ConstantInterpolatedStrings_S2.md&value=---%0Auid%3A%20CSharp10.ConstantInterpolatedStrings.S2%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L24",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -448,6 +450,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ConstantInterpolatedStrings_S3.md&value=---%0Auid%3A%20CSharp10.ConstantInterpolatedStrings.S3%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L25",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -1086,6 +1089,7 @@
   "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ConstantInterpolatedStrings.md&value=---%0Auid%3A%20CSharp10.ConstantInterpolatedStrings%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
   "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L21",
   "summary": "",
+  "description": "",
   "remarks": "",
   "conceptual": "",
   "implements": "",

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
@@ -179,6 +179,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_Issue7737_Foo.md&value=---%0Auid%3A%20CSharp10.Issue7737.Foo%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L33",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -816,6 +817,7 @@
   "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_Issue7737.md&value=---%0Auid%3A%20CSharp10.Issue7737%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
   "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L28",
   "summary": "",
+  "description": "",
   "remarks": "",
   "conceptual": "",
   "implements": "",

diff --git a/...lesTest.CSharp.Linux/api/CSharp10.ParameterlessStructConstructors.html.view.verified.json b/...lesTest.CSharp.Linux/api/CSharp10.ParameterlessStructConstructors.html.view.verified.json
@@ -178,6 +178,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ParameterlessStructConstructors__ctor.md&value=---%0Auid%3A%20CSharp10.ParameterlessStructConstructors.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L15",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -319,6 +320,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ParameterlessStructConstructors_X.md&value=---%0Auid%3A%20CSharp10.ParameterlessStructConstructors.X%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L11",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -505,6 +507,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ParameterlessStructConstructors_Description.md&value=---%0Auid%3A%20CSharp10.ParameterlessStructConstructors.Description%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L13",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -684,6 +687,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ParameterlessStructConstructors_Y.md&value=---%0Auid%3A%20CSharp10.ParameterlessStructConstructors.Y%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L12",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -1221,6 +1225,7 @@
   "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ParameterlessStructConstructors.md&value=---%0Auid%3A%20CSharp10.ParameterlessStructConstructors%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
   "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L9",
   "summary": "",
+  "description": "",
   "remarks": "",
   "conceptual": "",
   "implements": "",

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
@@ -318,6 +318,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ReadOnlyRecordStruct__ctor_System_Double_System_Double_System_Double_.md&value=---%0Auid%3A%20CSharp10.ReadOnlyRecordStruct.%23ctor(System.Double%2CSystem.Double%2CSystem.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L3",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -504,6 +505,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ReadOnlyRecordStruct_X.md&value=---%0Auid%3A%20CSharp10.ReadOnlyRecordStruct.X%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L3",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -683,6 +685,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ReadOnlyRecordStruct_Y.md&value=---%0Auid%3A%20CSharp10.ReadOnlyRecordStruct.Y%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L3",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -862,6 +865,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ReadOnlyRecordStruct_Z.md&value=---%0Auid%3A%20CSharp10.ReadOnlyRecordStruct.Z%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L3",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -1445,6 +1449,7 @@
   "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_ReadOnlyRecordStruct.md&value=---%0Auid%3A%20CSharp10.ReadOnlyRecordStruct%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
   "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L3",
   "summary": "",
+  "description": "",
   "remarks": "",
   "conceptual": "",
   "example": "",

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
@@ -272,6 +272,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_RecordClass__ctor_System_String_System_String_.md&value=---%0Auid%3A%20CSharp10.RecordClass.%23ctor(System.String%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L7",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -458,6 +459,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_RecordClass_FirstName.md&value=---%0Auid%3A%20CSharp10.RecordClass.FirstName%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L7",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -637,6 +639,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_RecordClass_LastName.md&value=---%0Auid%3A%20CSharp10.RecordClass.LastName%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L7",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -1321,6 +1324,7 @@
   "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_RecordClass.md&value=---%0Auid%3A%20CSharp10.RecordClass%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
   "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L7",
   "summary": "",
+  "description": "",
   "remarks": "",
   "conceptual": "",
   "example": "",

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
@@ -272,6 +272,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_RecordStruct__ctor_System_DateTime_System_Double_.md&value=---%0Auid%3A%20CSharp10.RecordStruct.%23ctor(System.DateTime%2CSystem.Double)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L5",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -458,6 +459,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_RecordStruct_Measurement.md&value=---%0Auid%3A%20CSharp10.RecordStruct.Measurement%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L5",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -637,6 +639,7 @@
           "platform": null,
           "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_RecordStruct_TakenAt.md&value=---%0Auid%3A%20CSharp10.RecordStruct.TakenAt%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
           "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L5",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "implements": "",
@@ -1220,6 +1223,7 @@
   "docurl": "https://github.com/dotnet/docfx/new/main/apiSpec/new?filename=CSharp10_RecordStruct.md&value=---%0Auid%3A%20CSharp10.RecordStruct%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A",
   "sourceurl": "https://github.com/dotnet/docfx/blob/main/samples/csharp/src/CSharp10.cs/#L5",
   "summary": "",
+  "description": "",
   "remarks": "",
   "conceptual": "",
   "example": "",

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
@@ -59,6 +59,7 @@
           "isEii": false,
           "docurl": "",
           "sourceurl": "",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "syntax": "",
@@ -120,6 +121,7 @@
           "isEii": false,
           "docurl": "",
           "sourceurl": "",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "syntax": "",
@@ -181,6 +183,7 @@
           "isEii": false,
           "docurl": "",
           "sourceurl": "",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "syntax": "",
@@ -249,6 +252,7 @@
           "isEii": false,
           "docurl": "",
           "sourceurl": "",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "syntax": "",
@@ -310,6 +314,7 @@
           "isEii": false,
           "docurl": "",
           "sourceurl": "",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "syntax": "",
@@ -371,6 +376,7 @@
           "isEii": false,
           "docurl": "",
           "sourceurl": "",
+          "description": "",
           "remarks": "",
           "conceptual": "",
           "syntax": "",
@@ -543,6 +549,7 @@
   "docurl": "",
   "sourceurl": "",
   "summary": "",
+  "description": "",
   "remarks": "",
   "conceptual": "",
   "syntax": "",