Add comments optimizations
authorThomas
Tue, 25 Sep 2018 12:34:41 +0200
branchoptimizations
changeset 236321803747b944
parent 2362 c1d0285f1a7f
child 2366 9f6de2f09992
Add comments
PEPCache.cs
     1.1 --- a/PEPCache.cs	Fri Sep 07 19:21:46 2018 +0200
     1.2 +++ b/PEPCache.cs	Tue Sep 25 12:34:41 2018 +0200
     1.3 @@ -3,11 +3,20 @@
     1.4  
     1.5  namespace pEp
     1.6  {
     1.7 +    /// <summary>
     1.8 +    /// The pEp cache.
     1.9 +    /// </summary>
    1.10      internal class PEPCache
    1.11      {
    1.12          private static MemoryCache cache = MemoryCache.Default;
    1.13          private const int MAX_TIME = 4; // time in hours
    1.14  
    1.15 +        /// <summary>
    1.16 +        /// Adds an item to the pEp cache.
    1.17 +        /// </summary>
    1.18 +        /// <param name="id">The identifier of the item to add.</param>
    1.19 +        /// <param name="item">The item to add.</param>
    1.20 +        /// <returns>True if added successfully, otherwise false.</returns>
    1.21          public static bool AddItemToCache(string id, object item)
    1.22          {
    1.23              bool success = false;
    1.24 @@ -33,6 +42,11 @@
    1.25              return success;
    1.26          }
    1.27  
    1.28 +        /// <summary>
    1.29 +        /// Gets an item from the pEp cache.
    1.30 +        /// </summary>
    1.31 +        /// <param name="id">The identifier of the item to retrieve.</param>
    1.32 +        /// <returns>The item or null if an error occured.</returns>
    1.33          public static object GetItemFromCache(string id)
    1.34          {
    1.35              object item = null;