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 notifications. #20492

Merged
merged 2 commits into from
Apr 24, 2024
Merged

[bgen] Generate xml documentation for notifications. #20492

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
c32850b
[bgen] Generate xml documentation for notifications.
rolfbjarne Apr 22, 2024
2dbc8d0
Auto-format source code
Apr 23, 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
42 changes: 42 additions & 0 deletions src/bgen/Generator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6598,6 +6598,11 @@ public void Generate (Type type)
print ("// Notifications");
print ("//");

print ($"/// <summary>Notifications posted by the <see cref=\"global::{type.FullName}\" /> class.</summary>");
print ("/// <remarks>");
print ("/// <para>This class contains various helper methods that allow developers to observe events posted in the notification hub (<see cref=\"Foundation.NSNotificationCenter\" />).</para>");
print ("/// <para>The methods defined in this class post events that invoke the provided method or lambda with a <see cref=\"Foundation.NSNotificationEventArgs\" /> parameter, which contains strongly typed properties for the notification arguments.</para>");
print ("/// </remarks>");
print ("public static partial class Notifications {\n");
foreach (var property in notifications.OrderBy (p => p.Name, StringComparer.Ordinal)) {
string notification_name = GetNotificationName (property);
Expand All @@ -6609,10 +6614,47 @@ public void Generate (Type type)

if (event_args_type is not null)
notification_event_arg_types [event_args_type] = event_args_type;

print ($"\t/// <summary>Strongly typed notification for the <see cref=\"global::{type.FullName}.{property.Name}\" /> constant.</summary>");
print ($"\t/// <param name=\"handler\">The handler that responds to the notification when it occurs.</param>");
print ($"\t/// <returns>Token object that can be used to stop receiving notifications by either disposing it or passing it to <see cref=\"Foundation.NSNotificationCenter.RemoveObservers(System.Collections.Generic.IEnumerable{{Foundation.NSObject}})\" />.</returns>");
print ($"\t/// <remarks>");
print ($"\t/// <para>This method can be used to subscribe to <see cref=\"global::{type.FullName}.{property.Name}\" /> notifications.</para>");
print ($"\t/// <example>");
print ($"\t/// <code lang=\"csharp lang-csharp\"><![CDATA[");
print ($"\t/// // Listen to all notifications posted for any object");
print ($"\t/// var token = {type.Name}.Notifications.Observe{notification_name} ((notification) => {{");
print ($"\t/// Console.WriteLine (\"Observed {notification_name}Notification!\");");
print ($"\t/// }};");
print ($"\t/// ");
print ($"\t/// // Stop listening for notifications");
print ($"\t/// token.Dispose ();");
print ($"\t/// ]]></code>");
print ($"\t/// </example>");
print ($"\t/// </remarks>");
print ("\tpublic static NSObject Observe{0} (EventHandler<{1}> handler)", notification_name, event_name);
print ("\t{");
print ("\t\treturn {0}.AddObserver ({1}, notification => handler (null, new {2} (notification)));", notification_center, property.Name, event_name);
print ("\t}");

print ($"\t/// <summary>Strongly typed notification for the <see cref=\"global::{type.FullName}.{property.Name}\" /> constant.</summary>");
print ($"\t/// <param name=\"objectToObserve\">The specific object to observe.</param>");
print ($"\t/// <param name=\"handler\">The handler that responds to the notification when it occurs.</param>");
print ($"\t/// <returns>Token object that can be used to stop receiving notifications by either disposing it or passing it to <see cref=\"Foundation.NSNotificationCenter.RemoveObservers(System.Collections.Generic.IEnumerable{{Foundation.NSObject}})\" />.</returns>");
print ($"\t/// <remarks>");
print ($"\t/// <para>This method can be used to subscribe to <see cref=\"global::{type.FullName}.{property.Name}\" /> notifications.</para>");
print ($"\t/// <example>");
print ($"\t/// <code lang=\"csharp lang-csharp\"><![CDATA[");
print ($"\t/// // Listen to all notifications posted for a single object");
print ($"\t/// var token = {type.Name}.Notifications.Observe{notification_name} (objectToObserve, (notification) => {{");
print ($"\t/// Console.WriteLine ($\"Observed {notification_name}Notification for {{nameof (objectToObserve)}}!\");");
print ($"\t/// }};");
print ($"\t/// ");
print ($"\t/// // Stop listening for notifications");
print ($"\t/// token.Dispose ();");
print ($"\t/// ]]></code>");
print ($"\t/// </example>");
print ($"\t/// </remarks>");
print ("\tpublic static NSObject Observe{0} (NSObject objectToObserve, EventHandler<{1}> handler)", notification_name, event_name);
print ("\t{");
print ("\t\treturn {0}.AddObserver ({1}, notification => handler (null, new {2} (notification)), objectToObserve);", notification_center, property.Name, event_name);
Expand Down
Loading