Update XML Doc

linksplatform · Oct 3, 2021 · af15482 · af15482
1 parent ddc79bd
commit af15482
Show file tree

Hide file tree

Showing 51 changed files with 0 additions and 1,105 deletions.
diff --git a/csharp/Platform.Data.Doublets.Sequences.Tests/DefaultSequenceAppenderTests.cs b/csharp/Platform.Data.Doublets.Sequences.Tests/DefaultSequenceAppenderTests.cs
@@ -22,12 +22,6 @@ namespace Platform.Data.Doublets.Sequences.Tests
     /// </summary>
     public class DefaultSequenceAppenderTests
     {
-        /// <summary>
-        /// <para>
-        /// The output.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly ITestOutputHelper _output;
 
         /// <summary>

diff --git a/csharp/Platform.Data.Doublets.Sequences.Tests/OptimalVariantSequenceTests.cs b/csharp/Platform.Data.Doublets.Sequences.Tests/OptimalVariantSequenceTests.cs
@@ -29,19 +29,7 @@ namespace Platform.Data.Doublets.Sequences.Tests
     /// </summary>
     public static class OptimalVariantSequenceTests
     {
-        /// <summary>
-        /// <para>
-        /// The sequence example.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly string _sequenceExample = "зеленела зелёная зелень";
-        /// <summary>
-        /// <para>
-        /// The lorem ipsum example.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly string _loremIpsumExample = @"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 Facilisi nullam vehicula ipsum a arcu cursus vitae congue mauris.
 Et malesuada fames ac turpis egestas sed.
@@ -164,32 +152,6 @@ public static void DictionaryBasedFrequencyStoredOptimalVariantSequenceTest()
             }
         }
 
-        /// <summary>
-        /// <para>
-        /// Executes the test using the specified sequences.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <param name="sequences">
-        /// <para>The sequences.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="sequence">
-        /// <para>The sequence.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="sequenceToItsLocalElementLevelsConverter">
-        /// <para>The sequence to its local element levels converter.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="index">
-        /// <para>The index.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="optimalVariantConverter">
-        /// <para>The optimal variant converter.</para>
-        /// <para></para>
-        /// </param>
         private static void ExecuteTest(Sequences sequences, ulong[] sequence, SequenceToItsLocalElementLevelsConverter<ulong> sequenceToItsLocalElementLevelsConverter, ISequenceIndex<ulong> index, OptimalVariantConverter<ulong> optimalVariantConverter)
         {
             index.Add(sequence);

diff --git a/csharp/Platform.Data.Doublets.Sequences.Tests/SequencesTests.cs b/csharp/Platform.Data.Doublets.Sequences.Tests/SequencesTests.cs
@@ -24,12 +24,6 @@ namespace Platform.Data.Doublets.Sequences.Tests
     /// </summary>
     public static class SequencesTests
     {
-        /// <summary>
-        /// <para>
-        /// The instance.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly LinksConstants<ulong> _constants = Default<LinksConstants<ulong>>.Instance;
 
         /// <summary>
@@ -436,7 +430,6 @@ public static void IndexTest()
             }
         }
 
-        /// <summary>Imported from https://raw.githubusercontent.com/wiki/Konard/LinksPlatform/%D0%9E-%D1%82%D0%BE%D0%BC%2C-%D0%BA%D0%B0%D0%BA-%D0%B2%D1%81%D1%91-%D0%BD%D0%B0%D1%87%D0%B8%D0%BD%D0%B0%D0%BB%D0%BE%D1%81%D1%8C.md</summary>
         private static readonly string _exampleText =
             @"([english version](https://github.com/Konard/LinksPlatform/wiki/About-the-beginning))
 
@@ -492,12 +485,6 @@ На один уровень внутрь (вниз)? Или на один ур
 
 [![анимация](https://raw.githubusercontent.com/Konard/LinksPlatform/master/doc/Intro/intro-animation-500.gif ""анимация"")](https://raw.githubusercontent.com/Konard/LinksPlatform/master/doc/Intro/intro-animation-500.gif)";
 
-        /// <summary>
-        /// <para>
-        /// The example lorem ipsum text.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly string _exampleLoremIpsumText =
             @"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.";

diff --git a/csharp/Platform.Data.Doublets.Sequences.Tests/TempLinksTestScope.cs b/csharp/Platform.Data.Doublets.Sequences.Tests/TempLinksTestScope.cs
@@ -52,12 +52,6 @@ public class TempLinksTestScope : DisposableBase
         /// <para></para>
         /// </summary>
         public string TempTransactionLogFilename { get; }
-        /// <summary>
-        /// <para>
-        /// The delete files.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly bool _deleteFiles;
 
         /// <summary>

diff --git a/csharp/Platform.Data.Doublets.Sequences.Tests/UInt64LinksTests.cs b/csharp/Platform.Data.Doublets.Sequences.Tests/UInt64LinksTests.cs
@@ -30,20 +30,8 @@ namespace Platform.Data.Doublets.Sequences.Tests
     /// </summary>
     public static class UInt64LinksTests
     {
-        /// <summary>
-        /// <para>
-        /// The instance.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly LinksConstants<ulong> _constants = Default<LinksConstants<ulong>>.Instance;
 
-        /// <summary>
-        /// <para>
-        /// The iterations.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private const long Iterations = 10 * 1024;
 
         #region Concept
@@ -428,12 +416,6 @@ public static void Bug1Test()
             File.Delete(tempTransactionLogFilename);
         }
 
-        /// <summary>
-        /// <para>
-        /// Exceptions the thrower.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static void ExceptionThrower() => throw new InvalidOperationException();
 
         /// <summary>
@@ -501,20 +483,6 @@ public static void RecursiveStringFormattingTest()
             }
         }
 
-        /// <summary>
-        /// <para>
-        /// Defaults the formatter using the specified sb.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <param name="sb">
-        /// <para>The sb.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="link">
-        /// <para>The link.</para>
-        /// <para></para>
-        /// </param>
         private static void DefaultFormatter(StringBuilder sb, ulong link)
         {
             sb.Append(link.ToString());

diff --git a/csharp/Platform.Data.Doublets.Sequences.Tests/UnicodeConvertersTests.cs b/csharp/Platform.Data.Doublets.Sequences.Tests/UnicodeConvertersTests.cs
@@ -64,28 +64,6 @@ public static void CharAndRawNumberUnicodeSymbolConvertersTest()
             }
         }
 
-        /// <summary>
-        /// <para>
-        /// Tests the char and unicode symbol converters using the specified links.
-        /// </para>
-        /// <para></para>
-        /// </summary>
-        /// <param name="links">
-        /// <para>The links.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="meaningRoot">
-        /// <para>The meaning root.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="addressToNumberConverter">
-        /// <para>The address to number converter.</para>
-        /// <para></para>
-        /// </param>
-        /// <param name="numberToAddressConverter">
-        /// <para>The number to address converter.</para>
-        /// <para></para>
-        /// </param>
         private static void TestCharAndUnicodeSymbolConverters(ILinks<ulong> links, ulong meaningRoot, IConverter<ulong> addressToNumberConverter, IConverter<ulong> numberToAddressConverter)
         {
             var unicodeSymbolMarker = links.CreateAndUpdate(meaningRoot, links.Constants.Itself);

diff --git a/csharp/Platform.Data.Doublets.Sequences/Converters/CompressingConverter.cs b/csharp/Platform.Data.Doublets.Sequences/Converters/CompressingConverter.cs
@@ -18,92 +18,20 @@ namespace Platform.Data.Doublets.Sequences.Converters
     /// </remarks>
     public class CompressingConverter<TLink> : LinksListToSequenceConverterBase<TLink>
     {
-        /// <summary>
-        /// <para>
-        /// The instance.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly LinksConstants<TLink> _constants = Default<LinksConstants<TLink>>.Instance;
-        /// <summary>
-        /// <para>
-        /// The default.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly EqualityComparer<TLink> _equalityComparer = EqualityComparer<TLink>.Default;
-        /// <summary>
-        /// <para>
-        /// The default.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly Comparer<TLink> _comparer = Comparer<TLink>.Default;
 
-        /// <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 base converter.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly IConverter<IList<TLink>, TLink> _baseConverter;
-        /// <summary>
-        /// <para>
-        /// The doublet frequencies cache.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly LinkFrequenciesCache<TLink> _doubletFrequenciesCache;
-        /// <summary>
-        /// <para>
-        /// The min frequency to compress.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly TLink _minFrequencyToCompress;
-        /// <summary>
-        /// <para>
-        /// The do initial frequencies increment.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly bool _doInitialFrequenciesIncrement;
-        /// <summary>
-        /// <para>
-        /// The max doublet.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private Doublet<TLink> _maxDoublet;
-        /// <summary>
-        /// <para>
-        /// The max doublet data.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private LinkFrequency<TLink> _maxDoubletData;
 
-        /// <summary>
-        /// <para>
-        /// The half doublet.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private struct HalfDoublet
         {
             /// <summary>

diff --git a/csharp/Platform.Data.Doublets.Sequences/Converters/OptimalVariantConverter.cs b/csharp/Platform.Data.Doublets.Sequences/Converters/OptimalVariantConverter.cs
@@ -18,27 +18,9 @@ namespace Platform.Data.Doublets.Sequences.Converters
     /// <seealso cref="LinksListToSequenceConverterBase{TLink}"/>
     public class OptimalVariantConverter<TLink> : LinksListToSequenceConverterBase<TLink>
     {
-        /// <summary>
-        /// <para>
-        /// The default.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly EqualityComparer<TLink> _equalityComparer = EqualityComparer<TLink>.Default;
-        /// <summary>
-        /// <para>
-        /// The default.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly Comparer<TLink> _comparer = Comparer<TLink>.Default;
 
-        /// <summary>
-        /// <para>
-        /// The sequence to its local element levels converter.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly IConverter<IList<TLink>> _sequenceToItsLocalElementLevelsConverter;
 
         /// <summary>

diff --git a/...p/Platform.Data.Doublets.Sequences/Converters/SequenceToItsLocalElementLevelsConverter.cs b/...p/Platform.Data.Doublets.Sequences/Converters/SequenceToItsLocalElementLevelsConverter.cs
@@ -16,20 +16,8 @@ namespace Platform.Data.Doublets.Sequences.Converters
     /// <seealso cref="IConverter{IList{TLink}}"/>
     public class SequenceToItsLocalElementLevelsConverter<TLink> : LinksOperatorBase<TLink>, IConverter<IList<TLink>>
     {
-        /// <summary>
-        /// <para>
-        /// The default.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly Comparer<TLink> _comparer = Comparer<TLink>.Default;
 
-        /// <summary>
-        /// <para>
-        /// The link to its frequency to number conveter.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly IConverter<Doublet<TLink>, TLink> _linkToItsFrequencyToNumberConveter;
 
         /// <summary>

diff --git a/csharp/Platform.Data.Doublets.Sequences/CriterionMatchers/MarkedSequenceCriterionMatcher.cs b/csharp/Platform.Data.Doublets.Sequences/CriterionMatchers/MarkedSequenceCriterionMatcher.cs
@@ -15,27 +15,9 @@ namespace Platform.Data.Doublets.Sequences.CriterionMatchers
     /// <seealso cref="ICriterionMatcher{TLink}"/>
     public class MarkedSequenceCriterionMatcher<TLink> : ICriterionMatcher<TLink>
     {
-        /// <summary>
-        /// <para>
-        /// The default.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly EqualityComparer<TLink> _equalityComparer = EqualityComparer<TLink>.Default;
 
-        /// <summary>
-        /// <para>
-        /// The links.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly ILinks<TLink> _links;
-        /// <summary>
-        /// <para>
-        /// The sequence marker link.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly TLink _sequenceMarkerLink;
 
         /// <summary>

diff --git a/csharp/Platform.Data.Doublets.Sequences/DefaultSequenceAppender.cs b/csharp/Platform.Data.Doublets.Sequences/DefaultSequenceAppender.cs
@@ -18,27 +18,9 @@ namespace Platform.Data.Doublets.Sequences
     /// <seealso cref="ISequenceAppender{TLink}"/>
     public class DefaultSequenceAppender<TLink> : LinksOperatorBase<TLink>, ISequenceAppender<TLink>
     {
-        /// <summary>
-        /// <para>
-        /// The default.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private static readonly EqualityComparer<TLink> _equalityComparer = EqualityComparer<TLink>.Default;
 
-        /// <summary>
-        /// <para>
-        /// The stack.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly IStack<TLink> _stack;
-        /// <summary>
-        /// <para>
-        /// The height provider.
-        /// </para>
-        /// <para></para>
-        /// </summary>
         private readonly ISequenceHeightProvider<TLink> _heightProvider;
 
         /// <summary>