Skip to content

fix: XML documentation for delegate verifications #631

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

Merged
vbreuss merged 2 commits into from
Apr 6, 2026
Merged

fix: XML documentation for delegate verifications #631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
288358a
fix: XML documentation for delegate verifications
vbreuss Apr 6, 2026
5527ad5
test: add XML documentation test for delegate verify interface
Copilot Apr 6, 2026
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
39 changes: 24 additions & 15 deletions Source/Mockolate.SourceGenerators/Sources/Sources.MockClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1040,7 +1040,7 @@ private static void AppendMockSubject_ImplementClass_AddEvent(StringBuilder sb,
}

sb.Append("\t\t/// <inheritdoc cref=\"").Append(@event.ContainingType.EscapeForXmlDoc()).Append('.')
.Append(@event.Name.EscapeForXmlDoc()).AppendLine("\" />");
.Append(@event.Name).AppendLine("\" />");
sb.Append(@event.Attributes, "\t\t");
if (explicitInterfaceImplementation)
{
Expand Down Expand Up @@ -1123,9 +1123,8 @@ private static void AppendMockSubject_ImplementClass_AddProperty(StringBuilder s
sb.Append("\t\t/// <inheritdoc cref=\"").Append(property.ContainingType.EscapeForXmlDoc()).Append('.').Append(
property.IndexerParameters is not null
? property.Name.Replace("[]",
$"[{string.Join(", ", property.IndexerParameters.Value.Select(p => $"{p.Type.Fullname}"))}]")
.EscapeForXmlDoc()
: property.Name.EscapeForXmlDoc())
$"[{string.Join(", ", property.IndexerParameters.Value.Select(p => $"{p.Type.Fullname.EscapeForXmlDoc()}"))}]")
: property.Name)
.AppendLine("\" />");
sb.Append(property.Attributes, "\t\t");
if (explicitInterfaceImplementation)
Expand Down Expand Up @@ -1769,7 +1768,7 @@ private static void DefineSetupInterface(StringBuilder sb, Class @class, MemberT
property.MemberType == memberType;
foreach (Property property in @class.AllProperties().Where(propertyPredicate))
{
sb.AppendXmlSummary($"Setup for the {property.Type.Fullname.EscapeForXmlDoc()} property <see cref=\"{property.ContainingType.EscapeForXmlDoc()}.{property.Name.EscapeForXmlDoc()}\" />.");
sb.AppendXmlSummary($"Setup for the {property.Type.Fullname.EscapeForXmlDoc()} property <see cref=\"{property.ContainingType.EscapeForXmlDoc()}.{property.Name}\" />.");
sb.Append("\t\tglobal::Mockolate.Setup.PropertySetup<").Append(property.Type.Fullname).Append("> ").Append(property.Name).Append(" { get; }").AppendLine();
sb.AppendLine();
}
Expand All @@ -1782,7 +1781,7 @@ private static void DefineSetupInterface(StringBuilder sb, Class @class, MemberT
=> @event.ExplicitImplementation is null && @event.MemberType == memberType;
foreach (Event @event in @class.AllEvents().Where(eventPredicate))
{
sb.AppendXmlSummary($"Setup for the event <see cref=\"{@event.ContainingType.EscapeForXmlDoc()}.{@event.Name.EscapeForXmlDoc()}\" />.");
sb.AppendXmlSummary($"Setup for the event <see cref=\"{@event.ContainingType.EscapeForXmlDoc()}.{@event.Name}\" />.");
sb.Append("\t\tglobal::Mockolate.Setup.EventSetup ").Append(@event.Name).Append(" { get; }").AppendLine();
sb.AppendLine();
}
Expand Down Expand Up @@ -2542,7 +2541,7 @@ private static void DefineRaiseInterface(StringBuilder sb, Class @class, MemberT
@event.MemberType == memberType;
foreach (Event @event in @class.AllEvents().Where(predicate))
{
sb.AppendXmlSummary($"Raise the <see cref=\"{@event.ContainingType.EscapeForXmlDoc()}.{@event.Name.EscapeForXmlDoc()}\"/> event.");
sb.AppendXmlSummary($"Raise the <see cref=\"{@event.ContainingType.EscapeForXmlDoc()}.{@event.Name}\"/> event.");
sb.Append("\t\tvoid ").Append(@event.Name).Append("(").Append(FormatParametersWithTypeAndName(@event.Delegate.Parameters)).Append(");").AppendLine();
sb.AppendLine();
}
Expand All @@ -2554,7 +2553,7 @@ private static void DefineRaiseInterface(StringBuilder sb, Class @class, MemberT
.Select(g => g.Single())
.Where(m => m.Delegate.Parameters.Count > 0))
{
sb.AppendXmlSummary($"Raise the <see cref=\"{@event.ContainingType.EscapeForXmlDoc()}.{@event.Name.EscapeForXmlDoc()}\"/> event.");
sb.AppendXmlSummary($"Raise the <see cref=\"{@event.ContainingType.EscapeForXmlDoc()}.{@event.Name}\"/> event.");
sb.Append("\t\tvoid ").Append(@event.Name).Append("(global::Mockolate.Parameters.IDefaultEventParameters parameters);").AppendLine();
sb.AppendLine();
}
Expand Down Expand Up @@ -2623,7 +2622,7 @@ private static void DefineVerifyInterface(StringBuilder sb, Class @class, string
property.MemberType == memberType;
foreach (Property property in @class.AllProperties().Where(propertyPredicate))
{
sb.AppendXmlSummary($"Verify interactions with the {property.Type.Fullname.EscapeForXmlDoc()} property <see cref=\"{property.ContainingType.EscapeForXmlDoc()}.{property.Name.EscapeForXmlDoc()}\" />.");
sb.AppendXmlSummary($"Verify interactions with the {property.Type.Fullname.EscapeForXmlDoc()} property <see cref=\"{property.ContainingType.EscapeForXmlDoc()}.{property.Name}\" />.");
sb.Append("\t\tglobal::Mockolate.Verify.VerificationPropertyResult<").Append(verifyName).Append(", ").Append(property.Type.Fullname).Append("> ").Append(property.Name).Append(" { get; }").AppendLine();
sb.AppendLine();
}
Expand Down Expand Up @@ -2723,12 +2722,22 @@ private static void AppendMethodVerifyDefinition(StringBuilder sb, Method method
{
string methodName = methodNameOverride ?? method.Name;
sb.Append("\t\t/// <summary>").AppendLine();
sb.Append("\t\t/// Verify invocations for the method <see cref=\"")
.Append(method.ContainingType.EscapeForXmlDoc())
.Append(".").Append(methodName.EscapeForXmlDoc()).Append("(");
sb.Append(string.Join(", ",
method.Parameters.Select(p => p.RefKind.GetString() + p.Type.Fullname.EscapeForXmlDoc())));
sb.Append(")\"/>").Append(method.Parameters.Count > 0 ? " with the given " : "");
if (methodNameOverride is null)
{
sb.Append("\t\t/// Verify invocations for the method <see cref=\"")
.Append(method.ContainingType.EscapeForXmlDoc())
.Append(".").Append(methodName.EscapeForXmlDoc()).Append("(");
sb.Append(string.Join(", ",
method.Parameters.Select(p => p.RefKind.GetString() + p.Type.Fullname.EscapeForXmlDoc())));
sb.Append(")\"/>");
}
else
{
sb.Append("\t\t/// Verify invocations for the delegate <see cref=\"")
.Append(method.ContainingType.EscapeForXmlDoc()).Append("\"/>");
}
Comment thread
vbreuss marked this conversation as resolved.

sb.Append(method.Parameters.Count > 0 ? " with the given " : "");
if (useParameters)
{
sb.Append("<paramref name=\"parameters\"/>");
Expand Down
27 changes: 27 additions & 0 deletions Tests/Mockolate.SourceGenerators.Tests/MockTests.DelegateTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,5 +291,32 @@ await That(result.Sources).ContainsKey("Mock.Program_ProcessResult.g.cs").WhoseV
.Contains("result1.TriggerCallbacks(result, value)")
.IgnoringNewlineStyle();
}

[Fact]
public async Task Delegate_ShouldHaveCorrectReferenceInXMLDocumentation()
{
GeneratorResult result = Generator
.Run("""
using System;
using Mockolate;

namespace MyCode;

public class Program
{
public static void Main(string[] args)
{
_ = DoSomething.CreateMock();
}

public delegate int DoSomething(int x, int y);
}
""");

await That(result.Sources).ContainsKey("Mock.Program_DoSomething.g.cs").WhoseValue
.Contains("Verify invocations for the delegate <see cref=\"global::MyCode.Program.DoSomething\"/> with the given <paramref name=\"x\"/>, <paramref name=\"y\"/>.").And
.Contains("Verify invocations for the delegate <see cref=\"global::MyCode.Program.DoSomething\"/> with the given <paramref name=\"parameters\"/>.").And
.DoesNotContain("Verify invocations for the method <see cref=\"global::MyCode.Program.DoSomething.Verify(");
}
}
}