cleanup comments a bit

LoneWandererProductions · LoneWandererProductions · commit 38a32fdbc460 · 2025-12-02T10:42:22.000+01:00
diff --git a/FileHandler/DirectoryInformation.cs b/FileHandler/DirectoryInformation.cs
@@ -1,7 +1,7 @@
 ﻿/*
 * COPYRIGHT:   See COPYING in the top level directory
 * PROJECT:     FileHandler
-* FILE:        FileHandler/DirectoryInformation.cs
+* FILE:        DirectoryInformation.cs
 * PURPOSE:     Generic System Functions for Directories
 * PROGRAMER:   Peter Geinitz (Wayfarer) 
 */
diff --git a/FileHandler/FileDetails.cs b/FileHandler/FileDetails.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileDetails.cs
+ * FILE:        FileDetails.cs
  * PURPOSE:     Contains more Information about certain Files
  * PROGRAMER:   Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileHandleCompress.cs b/FileHandler/FileHandleCompress.cs
@@ -1,7 +1,7 @@
 ﻿/*
 * COPYRIGHT:   See COPYING in the top level directory
 * PROJECT:     FileHandler
-* FILE:        FileHandler/FileHandleCompress.cs
+* FILE:        FileHandleCompress.cs
 * PURPOSE:     File Compression Utilities
 * PROGRAMER:   Peter Geinitz (Wayfarer)
 * Sources:     https://docs.microsoft.com/de-de/dotnet/api/system.io.compression.zipfile?view=net-5.0
diff --git a/FileHandler/FileHandleCopy.cs b/FileHandler/FileHandleCopy.cs
@@ -1,7 +1,7 @@
 ﻿/*
 * COPYRIGHT:   See COPYING in the top level directory
 * PROJECT:     FileHandler
-* FILE:        FileHandler/FileHandleCopy.cs
+* FILE:        FileHandleCopy.cs
 * PURPOSE:     Does all types of File Operations, Copy Files
 * PROGRAMER:   Peter Geinitz (Wayfarer)
 */
diff --git a/FileHandler/FileHandleCreate.cs b/FileHandler/FileHandleCreate.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileHandleCreate.cs
+ * FILE:        FileHandleCreate.cs
  * PURPOSE:     Handles all types of file creation operations
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileHandleCut.cs b/FileHandler/FileHandleCut.cs
@@ -1,7 +1,7 @@
 ﻿/*
 * COPYRIGHT:   See COPYING in the top level directory
 * PROJECT:     FileHandler
-* FILE:        FileHandler/FileHandleCut.cs
+* FILE:        FileHandleCut.cs
 * PURPOSE:     Does all types of File Operations, Copy Files and deletes them afterwards.
 * PROGRAMER:   Peter Geinitz (Wayfarer)
 */
diff --git a/FileHandler/FileHandleDelete.cs b/FileHandler/FileHandleDelete.cs
@@ -1,7 +1,7 @@
 ﻿/*
 * COPYRIGHT:   See COPYING in the top level directory
 * PROJECT:     FileHandler
-* FILE:        FileHandler/FileHandleDelete.cs
+* FILE:        FileHandleDelete.cs
 * PURPOSE:     Handles all types of file operations, including deletion
 * PROGRAMER:   Peter Geinitz (Wayfarer)
 */
diff --git a/FileHandler/FileHandleRename.cs b/FileHandler/FileHandleRename.cs
@@ -1,7 +1,7 @@
 ﻿/*
 * COPYRIGHT:   See COPYING in the top level directory
 * PROJECT:     FileHandler
-* FILE:        FileHandler/FileHandleRename.cs
+* FILE:        FileHandleRename.cs
 * PURPOSE:     Utility to Rename Files and Folders
 * PROGRAMER:   Peter Geinitz (Wayfarer)
 */
diff --git a/FileHandler/FileHandleRenameExtension.cs b/FileHandler/FileHandleRenameExtension.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileHandleRenameExtension.cs
+ * FILE:        FileHandleRenameExtension.cs
  * PURPOSE:     Unified safe rename helpers (append/remove/replace/reorder)
  * PROGRAMER:   Peter Geinitz (Wayfarer) 
  */
diff --git a/FileHandler/FileHandleSafeDelete.cs b/FileHandler/FileHandleSafeDelete.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileHandleSafeDelete.cs
+ * FILE:        FileHandleSafeDelete.cs
  * PURPOSE:     Variation of delete files, with Progress Bar and Deletion to Recycle Bin
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileHandleSearch.cs b/FileHandler/FileHandleSearch.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileHandleSearch.cs
+ * FILE:        FileHandleSearch.cs
  * PURPOSE:     Handles all types of file searches (refactored for clarity and safety)
  * PROGRAMER:   Peter Geinitz (Wayfarer) 
  */
diff --git a/FileHandler/FileHandleSearchExtension.cs b/FileHandler/FileHandleSearchExtension.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileSearchExtension.cs
+ * FILE:        FileSearchExtension.cs
  * PURPOSE:     Extension for FileSearch
  * PROGRAMER:   Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileHandleSort.cs b/FileHandler/FileHandleSort.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileHandleSort.cs
+ * FILE:        FileHandleSort.cs
  * PURPOSE:     Extension for File Sort
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileHandlerException.cs b/FileHandler/FileHandlerException.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileHandlerException.cs
+ * FILE:        FileHandlerException.cs
  * PURPOSE:     Exception Class
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileHandlerProcessing.cs b/FileHandler/FileHandlerProcessing.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileHandlerProcessing.cs
+ * FILE:        FileHandlerProcessing.cs
  * PURPOSE:     Helper Methods for the FileHandler library
  * PROGRAMMER:  Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileHandlerRegister.cs b/FileHandler/FileHandlerRegister.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileHandlerRegister.cs
+ * FILE:        FileHandlerRegister.cs
  * PURPOSE:     Register for basic configs and some Messages
  * PROGRAMER:   Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileHandlerRessources.cs b/FileHandler/FileHandlerRessources.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileHandlerResources.cs
+ * FILE:        FileHandlerResources.cs
  * PURPOSE:     String Resources
  * PROGRAMER:   Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileNameConverter.cs b/FileHandler/FileNameConverter.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileNameConverter.cs
+ * FILE:        FileNameConverter.cs
  * PURPOSE:     Helps to perform some generic renaming operations
  * PROGRAMER:   Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileObserver.cs b/FileHandler/FileObserver.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileObserver.cs
+ * FILE:        FileObserver.cs
  * PURPOSE:     File Watcher, that observes changes to Folder.
  * PROGRAMER:   Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/FileUtility.cs b/FileHandler/FileUtility.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/FileUtility.cs
+ * FILE:        FileUtility.cs
  * PURPOSE:     Some Basic helper Functions
  * PROGRAMER:   Peter Geinitz (Wayfarer)
  */
diff --git a/FileHandler/PathInformation.cs b/FileHandler/PathInformation.cs
@@ -1,7 +1,7 @@
 ﻿/*
  * COPYRIGHT:   See COPYING in the top level directory
  * PROJECT:     FileHandler
- * FILE:        FileHandler/PathInformation.cs
+ * FILE:        PathInformation.cs
  * PURPOSE:     Generic System Functions for Path
  * PROGRAMER:   Peter Geinitz (Wayfarer)
  */
diff --git a/LightVector/CircleObject.cs b/LightVector/CircleObject.cs
@@ -63,6 +63,12 @@ public override void ApplyTransformation(Transform transformation)
         }
     }
 
+    /// <summary>
+    /// Rotates the vector.
+    /// </summary>
+    /// <param name="vector">The vector.</param>
+    /// <param name="angle">The angle.</param>
+    /// <returns>New Vector.</returns>
     private static Vector2 RotateVector(Vector2 vector, double angle)
     {
         // Convert angle to radians
diff --git a/LightVector/GraphicManager.cs b/LightVector/GraphicManager.cs
@@ -28,14 +28,6 @@ public class GraphicManager : IGraphicManager
     private readonly Dictionary<int, SaveObject> _objects = new();
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Adds the object.
-    /// </summary>
-    /// <param name="id">The identifier.</param>
-    /// <param name="graphic">The graphic.</param>
-    /// <param name="layer">The layer.</param>
-    /// <param name="startCoordinates">The start coordinates.</param>
-    /// <param name="attributes">The attributes.</param>
     /// <exception cref="T:System.InvalidOperationException">An object with ID {id} already exists.</exception>
     public void AddObject(int id, GraphicObject graphic, int layer, Point startCoordinates,
         Dictionary<string, object>? attributes = null)
@@ -68,12 +60,6 @@ public void AddObject(int id, GraphicObject graphic, int layer, Point startCoord
     }
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Applies the transformation.
-    /// </summary>
-    /// <param name="id">The identifier.</param>
-    /// <param name="transformation">The transformation.</param>
-    /// <returns>Status of the transformation.</returns>
     /// <exception cref="KeyNotFoundException">No object found with ID {id}.</exception>
     public bool ApplyTransformation(int id, Transform transformation)
     {
@@ -93,34 +79,18 @@ public bool ApplyTransformation(int id, Transform transformation)
     }
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Gets the object by identifier.
-    /// </summary>
-    /// <param name="id">The identifier.</param>
-    /// <returns></returns>
     public SaveObject? GetObjectById(int id)
     {
         return _objects.TryGetValue(id, out var obj) ? obj : null;
     }
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Removes the object.
-    /// </summary>
-    /// <param name="id">The identifier.</param>
-    /// <returns>Status of removal.</returns>
     public bool RemoveObject(int id)
     {
         return _objects.Remove(id);
     }
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Updates the object layer.
-    /// </summary>
-    /// <param name="id">The identifier.</param>
-    /// <param name="newLayer">The new layer.</param>
-    /// <returns>Status of Update.</returns>
     public bool UpdateObjectLayer(int id, int newLayer)
     {
         if (!_objects.TryGetValue(id, out var obj))
@@ -133,12 +103,6 @@ public bool UpdateObjectLayer(int id, int newLayer)
     }
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Updates the object attributes.
-    /// </summary>
-    /// <param name="id">The identifier.</param>
-    /// <param name="newAttributes">The new attributes.</param>
-    /// <returns>Status of Attribute updates.</returns>
     public bool UpdateObjectAttributes(int id, Dictionary<string, object> newAttributes)
     {
         if (!_objects.TryGetValue(id, out var obj))
@@ -155,20 +119,12 @@ public bool UpdateObjectAttributes(int id, Dictionary<string, object> newAttribu
     }
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Saves to file.
-    /// </summary>
-    /// <param name="filePath">The file path.</param>
     public void SaveToFile(string filePath)
     {
         SaveHelper.XmlSerializerObject(new List<SaveObject>(_objects.Values), filePath);
     }
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Loads from file.
-    /// </summary>
-    /// <param name="filePath">The file path.</param>
     public void LoadFromFile(string filePath)
     {
         var loadedObjects = SaveHelper.XmlDeSerializerObject<List<SaveObject>>(filePath);
diff --git a/LightVector/GraphicObject.cs b/LightVector/GraphicObject.cs
@@ -69,7 +69,13 @@ public string FillColor
 
     [XmlIgnore] public Dictionary<string, object> OptionalAttributes { get; set; } = new();
 
-    // For XML serialization
+    /// <summary>
+    /// Gets or sets the serializable attributes.
+    ///  For XML serialization
+    /// </summary>
+    /// <value>
+    /// The serializable attributes.
+    /// </value>
     [XmlArray("OptionalAttributes")]
     [XmlArrayItem("Attribute")]
     public List<SerializableAttribute> SerializableAttributes
@@ -98,13 +104,18 @@ public List<SerializableAttribute> SerializableAttributes
     }
 
     /// <summary>
-    ///     Optional
+    /// Optional
     /// </summary>
+    /// <value>
+    /// The stroke line join.
+    /// </value>
     public PenLineJoin StrokeLineJoin { get; init; } = PenLineJoin.Bevel;
 
     /// <summary>
-    ///     Checks if this object supports the given transformation.
+    /// Checks if this object supports the given transformation.
     /// </summary>
+    /// <param name="transformation">The transformation.</param>
+    /// <returns>Checks if transformation is supported.</returns>
     public abstract bool SupportsTransformation(Transform transformation);
 
     /// <summary>
diff --git a/LightVector/IGraphicManager.cs b/LightVector/IGraphicManager.cs
@@ -55,13 +55,38 @@ void AddObject(int id, GraphicObject graphic, int layer, Point startCoordinates,
     /// <returns></returns>
     SaveObject? GetObjectById(int id);
 
+    /// <summary>
+    /// Removes the object.
+    /// </summary>
+    /// <param name="id">The identifier.</param>
+    /// <returns>Status of operation. if failed false, if success, true.</returns>
     bool RemoveObject(int id);
 
+    /// <summary>
+    /// Updates the object layer.
+    /// </summary>
+    /// <param name="id">The identifier.</param>
+    /// <param name="newLayer">The new layer.</param>
+    /// <returns>Status of operation. if failed false, if success, true.</returns>
     bool UpdateObjectLayer(int id, int newLayer);
 
+    /// <summary>
+    /// Updates the object attributes.
+    /// </summary>
+    /// <param name="id">The identifier.</param>
+    /// <param name="newAttributes">The new attributes.</param>
+    /// <returns>Status of operation. if failed false, if success, true.</returns>
     bool UpdateObjectAttributes(int id, Dictionary<string, object> newAttributes);
 
+    /// <summary>
+    /// Saves to file.
+    /// </summary>
+    /// <param name="filePath">The file path.</param>
     void SaveToFile(string filePath);
 
+    /// <summary>
+    /// Loads from file.
+    /// </summary>
+    /// <param name="filePath">The file path.</param>
     void LoadFromFile(string filePath);
 }
diff --git a/LightVector/WpfVectorRenderer.cs b/LightVector/WpfVectorRenderer.cs
@@ -41,12 +41,6 @@ public WpfVectorRenderer(IEnumerable<SaveObject> vectorObjects)
     }
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Renders to container.
-    /// </summary>
-    /// <returns>
-    ///     Returns a framework-specific container
-    /// </returns>
     public object RenderToContainer()
     {
         var canvas = new Canvas();
@@ -83,12 +77,6 @@ public object RenderToContainer()
 
 
     /// <inheritdoc />
-    /// <summary>
-    ///     Renders to image.
-    /// </summary>
-    /// <returns>
-    ///     Converts to a WPF Image
-    /// </returns>
     public ImageSource RenderToImage()
     {
         var canvas = (Canvas)RenderToContainer();
