Skip to content

Commit

Permalink
Correct Docstring for IPersistenceService
Browse files Browse the repository at this point in the history
  • Loading branch information
Vogel612 committed May 23, 2019
1 parent 61fd569 commit 7d9d6c2
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions Rubberduck.SettingsProvider/Persistence/IPersistenceService.cs
Expand Up @@ -3,12 +3,19 @@
/// <summary>
/// An interface exposing persistent storage for a serializable type.
/// This is intended to be used by Settings only.
///
/// </summary>
/// <remarks>
/// When the optional parameters are given, they override the storage location of the instance state for that one invocation.
/// Implementations of this interface are expected to <b>not</b> provide any caching.
///
/// Implementations can choose to disregard the optional argument being
/// </summary>
/// The following property must hold for a given instance of IPersistenceService:
/// <code>
/// T value;
/// string arg; // can be null
/// IPersistenceService<T> service;
/// service.Save(value, arg);
/// service.Load(arg).Equals(value); // must be true
/// </code>
/// </remarks>
/// <typeparam name="T">The Type of serializable object to store and retrieve persistently</typeparam>
public interface IPersistenceService<T> where T : new()
{
Expand Down

0 comments on commit 7d9d6c2

Please sign in to comment.