Skip to content

Commit

Permalink
implement dans comments
Browse files Browse the repository at this point in the history
  • Loading branch information
WaldemarCoding committed Apr 24, 2020
1 parent bb2efd3 commit 22d8eda
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 38 deletions.
36 changes: 1 addition & 35 deletions src/Forms/Prism.Forms/Navigation/INavigationParameters.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,56 +3,22 @@
namespace Prism.Navigation
{
/// <summary>
/// Provides a way for the INavigationService to pass parameteres during navigation.
/// Provides a way for the <see cref="INavigationService"/> to pass parameteres during navigation.
/// </summary>
public interface INavigationParameters : IEnumerable<KeyValuePair<string, object>>
{
/// <summary>
/// Adds the key and value to the KeyValuePair<string,object> collection
/// </summary>
/// <param name="key">The key to reference this value in the KeyValuePair<string, object></param>
/// <param name="value">The value of the parameter to store</param>
void Add(string key, object value);

/// <summary>
/// Checks collection for presense of key
/// </summary>
/// <param name="key">The key to check in the collection</param>
/// <returns><c>true</c> if key exists; else returns <c>false</c>.</returns>
bool ContainsKey(string key);

/// <summary>
/// The count, or number, of parameters in collection
/// </summary>
int Count { get; }

/// <summary>
/// Returns an IEnumerable of the Keys in the collection
/// </summary>
IEnumerable<string> Keys { get; }

/// <summary>
/// Returns the value of the member referenced by key
/// </summary>
/// <typeparam name="T">The type of object to be returned</typeparam>
/// <param name="key">The key for the value to be returned</param>
/// <returns>Returns a matching parameter of <see cref="T" /> if one exists in the Collection</returns>
T GetValue<T>(string key);

/// <summary>
/// Returns an IEnumerable of all parameters
/// </summary>
/// <typeparam name="T">The type for the values to be returned</typeparam>
/// <param name="key">The key for the values to be returned</param>
///<returns>Returns a IEnumberable of all the instances of type <see cref="T"/></returns>
IEnumerable<T> GetValues<T>(string key);

/// <summary>
/// Checks to see if the parameter collection contains the value
/// </summary>
/// <typeparam name="T">The type for the values to be returned</typeparam>
/// <param name="key">The key for the value to be returned</param>
/// <param name="value">Value of the returned parameter if it exists</param>
bool TryGetValue<T>(string key, out T value);

//legacy
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Prism.Navigation
{
/// <summary>
/// Internal - Provides a way for the INavigationService to pass parameteres during navigation.
/// Internal - Provides a way for the <see cref="INavigationService"/> to pass parameteres during navigation.
/// </summary>
public interface INavigationParametersInternal
{
Expand All @@ -24,7 +24,7 @@ public interface INavigationParametersInternal
/// </summary>
/// <typeparam name="T">The type of object to be returned</typeparam>
/// <param name="key">The key for the value to be returned</param>
/// <returns>Returns a matching parameter of <see cref="T" /> if one exists in the Collection</returns>
/// <returns>Returns a matching parameter of <typeparamref name="T"/> if one exists in the Collection</returns>
T GetValue<T>(string key);
}
}
1 change: 0 additions & 1 deletion src/Wpf/Prism.Wpf/Regions/IRegionNavigationJournal.cs
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ public interface IRegionNavigationJournal
/// Records the navigation to the entry..
/// </summary>
/// <param name="entry">The entry to record.</param>
/// <param name="persistInHistory">Persist navigation in history. </param>
void RecordNavigation(IRegionNavigationJournalEntry entry, bool persistInHistory);

/// <summary>
Expand Down

0 comments on commit 22d8eda

Please sign in to comment.