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.

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

#1978 - Add a few XML docs and correct class names #2556

Merged
merged 2 commits into from
Sep 10, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -202,3 +202,6 @@ FakesAssemblies/

# MFractor
.mfractor/

# Jetbrains files
.idea*
Christian-Oleson marked this conversation as resolved.
Show resolved Hide resolved
5 changes: 4 additions & 1 deletion src/Forms/Prism.Forms/AppModel/IPageLifecycleAware.cs
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
using System;
using System;
namespace Prism.AppModel
{
/// <summary>
/// An interface for using the page lifecycle events
/// </summary>
public interface IPageLifecycleAware
{
void OnAppearing();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,10 @@

namespace Prism.Ioc
{
public static class IContainerRegistryExtensions
/// <summary>
/// Extension methods for registering containers such as pages for navigation, dialog, etc.
Christian-Oleson marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
public static class ContainerRegistryExtensions
Christian-Oleson marked this conversation as resolved.
Show resolved Hide resolved
{
/// <summary>
/// Registers a Page for navigation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace Prism.Modularity
/// <summary>
/// <see cref="IModuleCatalog"/> extensions.
/// </summary>
public static class IModuleCatalogExtensions
public static class ModuleCatalogExtensions
Christian-Oleson marked this conversation as resolved.
Show resolved Hide resolved
{
/// <summary>
/// Adds the module.
Expand Down
8 changes: 8 additions & 0 deletions src/Forms/Prism.Forms/Navigation/IInitialize.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
namespace Prism.Navigation
{
/// <summary>
/// Synchronous initialization of navigation
Christian-Oleson marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
public interface IInitialize
{
/// <summary>
/// Synchronously initialize method which initializes the navigation.
Christian-Oleson marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
/// <param name="parameters"></param>
/// <returns></returns>
void Initialize(INavigationParameters parameters);
}
}
8 changes: 8 additions & 0 deletions src/Forms/Prism.Forms/Navigation/IInitializeAsync.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@

namespace Prism.Navigation
{
/// <summary>
/// Asynchronous initialization of navigation
Christian-Oleson marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
public interface IInitializeAsync
{
/// <summary>
/// Asynchronously initialize method which initializes the navigation.
Christian-Oleson marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
/// <param name="parameters"></param>
/// <returns></returns>
Task InitializeAsync(INavigationParameters parameters);
}
}