From 7d9d6c2a4651fbfc55e0b3d725feda53cfe06417 Mon Sep 17 00:00:00 2001
From: Vogel612 <vogel612@gmx.de>
Date: Thu, 23 May 2019 23:32:01 +0200
Subject: [PATCH] Correct Docstring for IPersistenceService

---
 .../Persistence/IPersistenceService.cs            | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/Rubberduck.SettingsProvider/Persistence/IPersistenceService.cs b/Rubberduck.SettingsProvider/Persistence/IPersistenceService.cs
index fcd545166c..5dc7c64c4f 100644
--- a/Rubberduck.SettingsProvider/Persistence/IPersistenceService.cs
+++ b/Rubberduck.SettingsProvider/Persistence/IPersistenceService.cs
@@ -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()
     {