Add comments to remove build warnings.

KevinJump · Oct 4, 2023 · c38cabd · c38cabd
1 parent 9f13b7d
commit c38cabd
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 1 deletion.
diff --git a/uSync.BackOffice/SyncHandlers/Handlers/ContentHandler.cs b/uSync.BackOffice/SyncHandlers/Handlers/ContentHandler.cs
@@ -58,6 +58,7 @@ public ContentHandler(
             this.serializer = syncItemFactory.GetSerializer<IContent>("ContentSerializer");
         }
 
+        /// <inheritdoc />
         protected override bool HasChildren(IContent item)
             => contentService.HasChildren(item.Id);
 

diff --git a/uSync.BackOffice/SyncHandlers/Handlers/MediaHandler.cs b/uSync.BackOffice/SyncHandlers/Handlers/MediaHandler.cs
@@ -51,6 +51,7 @@ public MediaHandler(
             this.mediaService = mediaService;
         }
 
+        /// <inheritdoc />
         protected override bool HasChildren(IMedia item)
             => mediaService.HasChildren(item.Id);
 

diff --git a/uSync.BackOffice/SyncHandlers/SyncHandlerBase.cs b/uSync.BackOffice/SyncHandlers/SyncHandlerBase.cs
@@ -54,6 +54,7 @@ public SyncHandlerBase(
             this.entityService = entityService;
         }
 
+        /// <inheritdoc />
         protected override bool HasChildren(TObject item)
             => entityService.GetChildren(item.Id).Any();
 

diff --git a/uSync.BackOffice/SyncHandlers/SyncHandlerRoot.cs b/uSync.BackOffice/SyncHandlers/SyncHandlerRoot.cs
@@ -881,6 +881,13 @@ virtual public IEnumerable<uSyncAction> Export(TObject item, string folder, Hand
             return uSyncActionHelper<XElement>.SetAction(attempt, filename, GetItemKey(item), this.Alias).AsEnumerableOfOne();
         }
 
+        /// <summary>
+        ///  does this item have any children ? 
+        /// </summary>
+        /// <remarks>
+        ///  on items where we can check this (quickly) we can reduce the number of checks we might 
+        ///  make on child items or cleaning up where we don't need to. 
+        /// </remarks>
         protected virtual bool HasChildren(TObject item)
             => true; 
 
@@ -1783,6 +1790,10 @@ private string GetNameFromFileOrNode(string filename, XElement node)
             => !string.IsNullOrWhiteSpace(filename) ? filename : node.GetAlias();
 
 
+        /// <summary>
+        ///  get thekey for any caches we might call (thread based cache value)
+        /// </summary>
+        /// <returns></returns>
         protected string GetCacheKeyBase()
             => $"keycache_{this.Alias}_{Thread.CurrentThread.ManagedThreadId}";
 

diff --git a/uSync.Core/Serialization/Serializers/ContentSerializerBase.cs b/uSync.Core/Serialization/Serializers/ContentSerializerBase.cs
@@ -641,7 +641,12 @@ protected uSyncChange HandleSortOrder(TObject item, int sortOrder)
             return null;
         }
 
-        protected abstract uSyncChange HandleTrashedState(TObject item, bool trashed, Guid restoreParent);
+        [Obsolete("Pass in a restore guid for the parent - should relationships be missing")]
+        protected virtual uSyncChange HandleTrashedState(TObject item, bool trashed)
+            => uSyncChange.NoChange($"Member/{item.Name}", item.Name);
+
+        protected virtual uSyncChange HandleTrashedState(TObject item, bool trashed, Guid restoreParent)
+            => uSyncChange.NoChange($"Member/{item.Name}", item.Name);
 
         protected string GetExportValue(object value, IPropertyType propertyType, string culture, string segment)
         {