Removed unnecessary comment templates

linksplatform · Sep 1, 2021 · 772f6ad · 772f6ad
1 parent 604985c
commit 772f6ad
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 195 deletions.
diff --git a/.idea/.idea.Platform.Data.Doublets.Xml/.idea/.gitignore b/.idea/.idea.Platform.Data.Doublets.Xml/.idea/.gitignore
diff --git a/.idea/.idea.Platform.Data.Doublets.Xml/.idea/.name b/.idea/.idea.Platform.Data.Doublets.Xml/.idea/.name
diff --git a/.idea/.idea.Platform.Data.Doublets.Xml/.idea/encodings.xml b/.idea/.idea.Platform.Data.Doublets.Xml/.idea/encodings.xml
diff --git a/.idea/.idea.Platform.Data.Doublets.Xml/.idea/indexLayout.xml b/.idea/.idea.Platform.Data.Doublets.Xml/.idea/indexLayout.xml
diff --git a/.idea/.idea.Platform.Data.Doublets.Xml/.idea/vcs.xml b/.idea/.idea.Platform.Data.Doublets.Xml/.idea/vcs.xml
diff --git a/csharp/Platform.Data.Doublets.Xml/XmlElementContext.cs b/csharp/Platform.Data.Doublets.Xml/XmlElementContext.cs
@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 
-#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
+#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member
 
 namespace Platform.Data.Doublets.Xml
 {
@@ -12,39 +12,11 @@ namespace Platform.Data.Doublets.Xml
     /// </summary>
     internal class XmlElementContext
     {
-        /// <summary>
-        /// <para>
-        /// The children names counts.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        public readonly Dictionary<string, int> ChildrenNamesCounts;
-        /// <summary>
-        /// <para>
-        /// The total children.
-        /// </para>
-        /// <para></para>
-        /// </summary>
+        public readonly Dictionary<string, int> ChildrenNamesCounts; 
         public int TotalChildren;
 
-        /// <summary>
-        /// <para>
-        /// Initializes a new <see cref="XmlElementContext"/> instance.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         public XmlElementContext() => ChildrenNamesCounts = new Dictionary<string, int>();
 
-        /// <summary>
-        /// <para>
-        /// Increments the child name count using the specified name.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <param name="name">
-        /// <para>The name.</para>
-        /// <para></para>
-        /// </param>
         public void IncrementChildNameCount(string name)
         {
             if (ChildrenNamesCounts.TryGetValue(name, out int count))

diff --git a/csharp/Platform.Data.Doublets.Xml/XmlElementCounter.cs b/csharp/Platform.Data.Doublets.Xml/XmlElementCounter.cs
@@ -64,29 +64,7 @@ public Task Count(string file, string elementName, CancellationToken token)
                 }
             }, token);
         }
-
-        /// <summary>
-        /// <para>
-        /// Counts the reader.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <param name="reader">
-        /// <para>The reader.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="elementNameToCount">
-        /// <para>The element name to count.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="token">
-        /// <para>The token.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="context">
-        /// <para>The context.</para>
-        /// <para></para>
-        /// </param>
+
         private void Count(XmlReader reader, string elementNameToCount, CancellationToken token, XmlElementContext context)
         {
             var rootContext = (RootElementContext)context;
@@ -146,30 +124,9 @@ private void Count(XmlReader reader, string elementNameToCount, CancellationToke
                 }
             }
         }
-
-        /// <summary>
-        /// <para>
-        /// Returns the x path using the specified path.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <param name="path">
-        /// <para>The path.</para>
-        /// <para></para>
-        /// </param>
-        /// <returns>
-        /// <para>The string</para>
-        /// <para></para>
-        /// </returns>
+
         private string ToXPath(Stack<string> path) => string.Join("/", path.Reverse());
-
-        /// <summary>
-        /// <para>
-        /// Represents the root element context.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <seealso cref="XmlElementContext"/>
+
         private class RootElementContext : XmlElementContext
         {
             /// <summary>

diff --git a/csharp/Platform.Data.Doublets.Xml/XmlExporter.cs b/csharp/Platform.Data.Doublets.Xml/XmlExporter.cs
@@ -16,14 +16,8 @@ namespace Platform.Data.Doublets.Xml
     /// </para>
     /// <para></para>
     /// </summary>
-    class XmlExporter<TLink>
+    public class XmlExporter<TLink>
     {
-        /// <summary>
-        /// <para>
-        /// The storage.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly IXmlStorage<TLink> _storage;
 
         /// <summary>

diff --git a/csharp/Platform.Data.Doublets.Xml/XmlImporter.cs b/csharp/Platform.Data.Doublets.Xml/XmlImporter.cs
@@ -19,12 +19,6 @@ namespace Platform.Data.Doublets.Xml {
     /// </summary>
     public class XmlImporter<TLink>
     {
-        /// <summary>
-        /// <para>
-        /// The storage.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly IXmlStorage<TLink> _storage;
 
         /// <summary>
@@ -73,25 +67,7 @@ public Task Import(string file, CancellationToken token)
 
             }, token);
         }
-
-        /// <summary>
-        /// <para>
-        /// Reads the reader.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <param name="reader">
-        /// <para>The reader.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="token">
-        /// <para>The token.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="context">
-        /// <para>The context.</para>
-        /// <para></para>
-        /// </param>
+
         private void Read(XmlReader reader, CancellationToken token, ElementContext context)
         {
             var parentContexts = new Stack<ElementContext>();
@@ -146,49 +122,12 @@ private void Read(XmlReader reader, CancellationToken token, ElementContext cont
             }
         }
 
-        /// <summary>
-        /// <para>
-        /// Returns the x path using the specified path.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <param name="path">
-        /// <para>The path.</para>
-        /// <para></para>
-        /// </param>
-        /// <returns>
-        /// <para>The string</para>
-        /// <para></para>
-        /// </returns>
         private string ToXPath(Stack<string> path) => string.Join("/", path.Reverse());
 
-        /// <summary>
-        /// <para>
-        /// Represents the element context.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <seealso cref="XmlElementContext"/>
+
         private class ElementContext : XmlElementContext
         {
-            /// <summary>
-            /// <para>
-            /// The parent.
-            /// </para>
-            /// <para></para>
-            /// </summary>
             public readonly TLink Parent;
-
-            /// <summary>
-            /// <para>
-            /// Initializes a new <see cref="ElementContext"/> instance.
-            /// </para>
-            /// <para></para>
-            /// </summary>
-            /// <param name="parent">
-            /// <para>A parent.</para>
-            /// <para></para>
-            /// </param>
             public ElementContext(TLink parent) => Parent = parent;
         }
     }

diff --git a/csharp/Platform.Data.Doublets.Xml/XmlIndexer.cs b/csharp/Platform.Data.Doublets.Xml/XmlIndexer.cs
@@ -20,48 +20,11 @@ namespace Platform.Data.Doublets.Xml
     /// <seealso cref="IXmlStorage{TLink}"/>
     public class XmlIndexer<TLink> : IXmlStorage<TLink>
     {
-        /// <summary>
-        /// <para>
-        /// The zero.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly TLink _zero = default;
-        /// <summary>
-        /// <para>
-        /// The zero.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly TLink _one = Arithmetic.Increment(_zero);
-
-        /// <summary>
-        /// <para>
-        /// The index.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly CachedFrequencyIncrementingSequenceIndex<TLink> _index;
-        /// <summary>
-        /// <para>
-        /// The char to unicode symbol converter.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly CharToUnicodeSymbolConverter<TLink> _charToUnicodeSymbolConverter;
-        /// <summary>
-        /// <para>
-        /// The unicode symbol marker.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private TLink _unicodeSymbolMarker;
-        /// <summary>
-        /// <para>
-        /// The null constant.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly TLink _nullConstant;
 
         /// <summary>
@@ -92,17 +55,7 @@ public XmlIndexer(ILinks<TLink> links)
             InitConstants(links);
             _charToUnicodeSymbolConverter = new CharToUnicodeSymbolConverter<TLink>(links, addressToRawNumberConverter, _unicodeSymbolMarker);
         }
-
-        /// <summary>
-        /// <para>
-        /// Inits the constants using the specified links.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <param name="links">
-        /// <para>The links.</para>
-        /// <para></para>
-        /// </param>
+
         private void InitConstants(ILinks<TLink> links)
         {
             var markerIndex = _one;
@@ -303,7 +256,7 @@ public TLink GetTextElement(string content)
         /// <para>A list of i list t link</para>
         /// <para></para>
         /// </returns>
-        public IList<IList<TLink>> GetChildren(TLink parent)
+        public IList<TLink> GetChildren(TLink parent)
         {
             throw new System.NotImplementedException();
         }