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

Jump to bottom

fix: mref mustach template description leak #9632

Merged
merged 3 commits into from
Jan 21, 2024
Merged

fix: mref mustach template description leak #9632

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
48b8f77
fix: mref mustach template description leak
yufeih Jan 21, 2024
0a1f0a9
test(snapshot): update snapshots 09b47a91dba00d85ba3302170f2353d91a19…
yufeih Jan 21, 2024
87764bc
test(snapshot): update snapshots 09b47a91dba00d85ba3302170f2353d91a19…
yufeih Jan 21, 2024
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
27 changes: 27 additions & 0 deletions samples/seed/dotnet/project/Project/Class1.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}
}
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 @@ -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 || "";
Expand Down
4 changes: 4 additions & 0 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 @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down
2 changes: 2 additions & 0 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 @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down
5 changes: 5 additions & 0 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 @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down
5 changes: 5 additions & 0 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 @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down
4 changes: 4 additions & 0 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 @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down
4 changes: 4 additions & 0 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 @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down Expand Up @@ -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": "",
Expand Down
7 changes: 7 additions & 0 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 @@ -59,6 +59,7 @@
"isEii": false,
"docurl": "",
"sourceurl": "",
"description": "",
"remarks": "",
"conceptual": "",
"syntax": "",
Expand Down Expand Up @@ -120,6 +121,7 @@
"isEii": false,
"docurl": "",
"sourceurl": "",
"description": "",
"remarks": "",
"conceptual": "",
"syntax": "",
Expand Down Expand Up @@ -181,6 +183,7 @@
"isEii": false,
"docurl": "",
"sourceurl": "",
"description": "",
"remarks": "",
"conceptual": "",
"syntax": "",
Expand Down Expand Up @@ -249,6 +252,7 @@
"isEii": false,
"docurl": "",
"sourceurl": "",
"description": "",
"remarks": "",
"conceptual": "",
"syntax": "",
Expand Down Expand Up @@ -310,6 +314,7 @@
"isEii": false,
"docurl": "",
"sourceurl": "",
"description": "",
"remarks": "",
"conceptual": "",
"syntax": "",
Expand Down Expand Up @@ -371,6 +376,7 @@
"isEii": false,
"docurl": "",
"sourceurl": "",
"description": "",
"remarks": "",
"conceptual": "",
"syntax": "",
Expand Down Expand Up @@ -543,6 +549,7 @@
"docurl": "",
"sourceurl": "",
"summary": "",
"description": "",
"remarks": "",
"conceptual": "",
"syntax": "",
Expand Down
Loading