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

[bgen] Generate xml documentation for the extension class we generate for protocols. #20564

Merged
merged 2 commits into from
May 7, 2024
Merged

[bgen] Generate xml documentation for the extension class we generate for protocols. #20564

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
4bd9b92
[bgen] Generate xml documentation for the extension class we generate…
rolfbjarne Apr 25, 2024
5c2868b
Merge remote-tracking branch 'origin/main' into xml-docs-protocol-ext…
rolfbjarne May 6, 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
6 changes: 6 additions & 0 deletions src/bgen/Generator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4888,6 +4888,12 @@ void GenerateProtocolTypes (Type type, string class_visibility, string TypeName,
include_extensions = optionalInstanceMethods.Any () || optionalInstanceProperties.Any () || requiredInstanceAsyncMethods.Any ();
if (include_extensions) {
// extension methods
if (BindingTouch.SupportsXmlDocumentation) {
print ($"/// <summary>Extension methods to the <see cref=\"I{TypeName}\" /> interface to support all the methods from the {protocol_name} protocol.</summary>");
print ($"/// <remarks>");
print ($"/// <para>The extension methods for <see cref=\"I{TypeName}\" /> interface allow developers to treat instances of the interface as having all the optional methods of the original {protocol_name} protocol. Since the interface only contains the required members, these extension methods allow developers to call the optional members of the protocol.</para>");
print ($"/// </remarks>");
}
PrintAttributes (type, preserve: true, advice: true);
print ("{1} unsafe static partial class {0}_Extensions {{", TypeName, class_visibility);
indent++;
Expand Down
Loading