Skip to content

Commit 1e44aed

Browse files
authored
fix(doc): AutoSuspendHelper not known by all target frameworks (#4245)
AutoSuspendHelper symbol is only existing for target frameworks which include a src/ReactiveUI/Platforms/.../AutoSuspendHelper.cs class. In order to hide this warning for all other platforms, the `<c>...</c>` syntax is used instead of a `<see cref="..."/>`. This PR also fixes an ambigous reference issue as there are two overloads of `Activity.OnSaveInstanceState`
1 parent be0eb89 commit 1e44aed

File tree

4 files changed

+7
-7
lines changed

4 files changed

+7
-7
lines changed

src/ReactiveUI/Platforms/android/AutoSuspendHelper.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ public AutoSuspendHelper(Application hostApplication) // TODO: Create Test
8888
/// Gets or sets the latest bundle.
8989
/// </summary>
9090
/// <remarks>
91-
/// Updated whenever <see cref="Activity.OnSaveInstanceState"/> runs so callers can detect whether
92-
/// <see cref="OnActivityCreated(Activity?, Bundle?)"/> represents a cold launch (<see langword="null"/>) or a
91+
/// Updated whenever <see cref="Activity.OnSaveInstanceState(Bundle)"/> runs so callers can detect whether
92+
/// <see cref="ObservableLifecycle.OnActivityCreated(Activity?, Bundle?)"/> represents a cold launch (<see langword="null"/>) or a
9393
/// recreation with persisted state.
9494
/// </remarks>
9595
public static Bundle? LatestBundle { get; set; }

src/ReactiveUI/Platforms/mac/AutoSuspendHelper.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public AutoSuspendHelper(NSApplicationDelegate appDelegate)
8484
/// <param name="sender">The sender.</param>
8585
/// <returns>The termination reply from the application.</returns>
8686
/// <remarks>
87-
/// Delays the OS shutdown until <see cref="RxApp.SuspensionHost.ShouldPersistState"/> subscribers finish writing
87+
/// Delays the OS shutdown until <see cref="ISuspensionHost.ShouldPersistState"/> subscribers finish writing
8888
/// <see cref="ISuspensionHost.AppState"/>, replying with <see cref="NSApplication.ReplyToApplicationShouldTerminate(bool)"/>
8989
/// once persistence completes.
9090
/// </remarks>

src/ReactiveUI/Suspension/SuspensionHost.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ namespace ReactiveUI;
1212
/// <remarks>
1313
/// <para>
1414
/// <see cref="SuspensionHost"/> backs <see cref="RxApp.SuspensionHost"/> and provides concrete observables that are wired up
15-
/// by helpers such as <see cref="AutoSuspendHelper"/>. Platform hosts push their lifecycle notifications into the
16-
/// <c>ReplaySubject</c> instances exposed here and view models subscribe through <see cref="ISuspensionHost"/>.
15+
/// by helpers such as <c>AutoSuspendHelper</c>. Platform hosts push their lifecycle notifications into the
16+
/// <see cref="ReplaySubject{T}"/> instances exposed here and view models subscribe through <see cref="ISuspensionHost"/>.
1717
/// </para>
1818
/// <para>
19-
/// Consumers rarely instantiate this type directly; instead call <c>RxApp.SuspensionHost</c> to access the singleton. The
19+
/// Consumers rarely instantiate this type directly; instead call <see cref="RxApp.SuspensionHost"/> to access the singleton. The
2020
/// object is intentionally thread-safe via <see cref="ReplaySubject{T}"/> so events raised prior to subscription are
2121
/// replayed to late subscribers.
2222
/// </para>

src/ReactiveUI/Suspension/SuspensionHostExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ namespace ReactiveUI;
1212
/// <para>
1313
/// These helpers provide strongly-typed access to the current application state and wire up the
1414
/// <see cref="ISuspensionDriver"/> responsible for persisting it. They are typically invoked from platform bootstrap
15-
/// classes after registering an <see cref="AutoSuspendHelper"/>.
15+
/// classes after registering an <c>AutoSuspendHelper</c>.
1616
/// </para>
1717
/// </remarks>
1818
public static class SuspensionHostExtensions

0 commit comments

Comments
 (0)