Skip to content

Add xml docs for HandleAsync methods of gateway handlers #224

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
KubaZ2 merged 2 commits into from
Nov 20, 2025
Merged

Add xml docs for HandleAsync methods of gateway handlers #224

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ad7f83
Add xml docs for HandleAsync methods of gateway handlers
KubaZ2 Nov 20, 2025
787f28c
Merge branch 'alpha' into feature/handle-async-xml-doc
KubaZ2 Nov 20, 2025
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
36 changes: 33 additions & 3 deletions SourceGenerators/HostingGatewayEventsGenerator/HostingGatewayEventsGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,15 @@ private void WriteGatewayHandlerInterfaces(StringWriter stringWriter, IEventSymb

stringWriter.WriteLine("{");

var eventType = (INamedTypeSymbol)eventSymbol.Type;
var hasArg = eventType.Arity is 2;

WriteHandleAsyncXmlDoc(stringWriter, false, hasArg);

stringWriter.WriteIndentation(1);
stringWriter.Write("public global::System.Threading.Tasks.ValueTask HandleAsync(");

var eventType = (INamedTypeSymbol)eventSymbol.Type;
if (eventType.Arity is 2)
if (hasArg)
{
stringWriter.Write(eventType.TypeArguments[0].ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat));
stringWriter.Write(" arg");
Expand All @@ -141,10 +145,12 @@ private void WriteGatewayHandlerInterfaces(StringWriter stringWriter, IEventSymb

stringWriter.WriteLine("{");

WriteHandleAsyncXmlDoc(stringWriter, true, hasArg);

stringWriter.WriteIndentation(1);
stringWriter.Write("public global::System.Threading.Tasks.ValueTask HandleAsync(global::NetCord.Gateway.GatewayClient client");

if (eventType.Arity is 2)
if (hasArg)
{
stringWriter.Write(", ");
stringWriter.Write(eventType.TypeArguments[0].ToDisplayString(SymbolDisplayFormat.FullyQualifiedFormat));
Expand All @@ -157,6 +163,30 @@ private void WriteGatewayHandlerInterfaces(StringWriter stringWriter, IEventSymb
}
}

private void WriteHandleAsyncXmlDoc(StringWriter stringWriter, bool hasClient, bool hasArg)
{
stringWriter.WriteIndentation(1);
stringWriter.WriteLine("/// <summary>");

stringWriter.WriteIndentation(1);
stringWriter.WriteLine("/// Handles the gateway event.");

stringWriter.WriteIndentation(1);
stringWriter.WriteLine("/// </summary>");

if (hasClient)
{
stringWriter.WriteIndentation(1);
stringWriter.WriteLine("/// <param name=\"client\">The gateway client that represents the shard that received the event.</param>");
}

if (hasArg)
{
stringWriter.WriteIndentation(1);
stringWriter.WriteLine("/// <param name=\"arg\">The event argument.</param>");
}
}

private string GenerateHandlerRegistrationMethods(IEventSymbol[] events)
{
StringWriter stringWriter = new();
Expand Down
Loading