Remove unnecessary comments; Fix docs in LuceneTestCase w/r/t setup/t…

…eardown
apache · Nov 27, 2024 · a3b9f0c · a3b9f0c
1 parent 157528c
commit a3b9f0c
Show file tree

Hide file tree

Showing 13 changed files with 8 additions and 48 deletions.
diff --git a/src/Lucene.Net.TestFramework/Util/LuceneTestCase.cs b/src/Lucene.Net.TestFramework/Util/LuceneTestCase.cs
@@ -66,8 +66,14 @@ namespace Lucene.Net.Util
     /// <h3>Class and instance setup.</h3>
     ///
     /// <para>
-    /// The preferred way to specify class (suite-level) setup/cleanup is to use
-    /// static methods annotated with <see cref="NUnit.Framework.OneTimeSetUpAttribute"/> and <see cref="NUnit.Framework.OneTimeTearDownAttribute"/>. Any
+    /// The preferred way to specify class (suite-level) setup/cleanup is to override
+    /// <see cref="OneTimeSetUp"/> and <see cref="OneTimeTearDown"/>. Be sure
+    /// to call <c>base.OneTimeSetUp()</c> BEFORE you initialize your class and
+    /// call <c>base.OneTimeTearDown()</c> AFTER you clean up your class. NUnit
+    /// will find the <see cref="NUnit.Framework.OneTimeSetUpAttribute"/> and
+    /// <see cref="NUnit.Framework.OneTimeTearDownAttribute"/> of the base class,
+    /// so using them on the <see cref="OneTimeSetUp"/> and
+    /// <see cref="OneTimeTearDown"/> method overrides is not strictly required. Any
     /// code in these methods is executed within the test framework's control and
     /// ensure proper setup has been made. <b>Try not to use static initializers
     /// (including complex readonly field initializers).</b> Static initializers are

diff --git a/src/Lucene.Net.Tests.Facet/Taxonomy/TestTaxonomyFacetAssociations.cs b/src/Lucene.Net.Tests.Facet/Taxonomy/TestTaxonomyFacetAssociations.cs
@@ -48,10 +48,6 @@ public class TestTaxonomyFacetAssociations : FacetTestCase
 
         private static FacetsConfig config;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because Similarity and TimeZone are not static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/Spans/TestBasics.cs b/src/Lucene.Net.Tests/Search/Spans/TestBasics.cs
@@ -97,10 +97,6 @@ public override void Reset()
 
         internal static Analyzer simplePayloadAnalyzer;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because NewIndexWriterConfig is no longer static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/Spans/TestFieldMaskingSpanQuery.cs b/src/Lucene.Net.Tests/Search/Spans/TestFieldMaskingSpanQuery.cs
@@ -57,10 +57,6 @@ protected internal static Field GetField(string name, string value)
         protected internal static Directory directory;
         protected internal static IndexReader reader;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because NewIndexWriterConfig is no longer static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/TestBooleanMinShouldMatch.cs b/src/Lucene.Net.Tests/Search/TestBooleanMinShouldMatch.cs
@@ -45,10 +45,6 @@ public class TestBooleanMinShouldMatch : LuceneTestCase
         private static IndexReader r;
         private static IndexSearcher s;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because NewStringField is no longer static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/TestFieldCache.cs b/src/Lucene.Net.Tests/Search/TestFieldCache.cs
@@ -104,8 +104,6 @@ public override void TearDown()
             base.TearDown();
         }
 
-
-        // LUCENENET: Changed to non-static because NewIndexWriterConfig is non-static
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/TestMinShouldMatch2.cs b/src/Lucene.Net.Tests/Search/TestMinShouldMatch2.cs
@@ -62,10 +62,6 @@ public class TestMinShouldMatch2 : LuceneTestCase
         internal static readonly string[] mediumTerms = new string[] { "e", "f", "g" };
         internal static readonly string[] rareTerms = new string[] { "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z" };
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because Similarity and TimeZone are not static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/TestMultiTermQueryRewrites.cs b/src/Lucene.Net.Tests/Search/TestMultiTermQueryRewrites.cs
@@ -47,10 +47,6 @@ public class TestMultiTermQueryRewrites : LuceneTestCase
         private static IndexReader reader, multiReader, multiReaderDupls;
         private static IndexSearcher searcher, multiSearcher, multiSearcherDupls;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because Similarity and TimeZone are not static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/TestNGramPhraseQuery.cs b/src/Lucene.Net.Tests/Search/TestNGramPhraseQuery.cs
@@ -33,10 +33,6 @@ public class TestNGramPhraseQuery : LuceneTestCase
         private static IndexReader reader;
         private static Directory directory;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because Similarity and TimeZone are not static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/TestNumericRangeQuery32.cs b/src/Lucene.Net.Tests/Search/TestNumericRangeQuery32.cs
@@ -62,10 +62,6 @@ public class TestNumericRangeQuery32 : LuceneTestCase
         private static IndexReader reader = null;
         private static IndexSearcher searcher = null;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because NewIndexWriterConfig is no longer static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/TestNumericRangeQuery64.cs b/src/Lucene.Net.Tests/Search/TestNumericRangeQuery64.cs
@@ -62,10 +62,6 @@ public class TestNumericRangeQuery64 : LuceneTestCase
         private static IndexReader reader = null;
         private static IndexSearcher searcher = null;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because NewIndexWriterConfig is no longer static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/TestPrefixInBooleanQuery.cs b/src/Lucene.Net.Tests/Search/TestPrefixInBooleanQuery.cs
@@ -46,10 +46,6 @@ public class TestPrefixInBooleanQuery : LuceneTestCase
         private static IndexReader reader;
         private static IndexSearcher searcher;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because Similarity and TimeZone are not static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {

diff --git a/src/Lucene.Net.Tests/Search/TestTermVectors.cs b/src/Lucene.Net.Tests/Search/TestTermVectors.cs
@@ -48,10 +48,6 @@ public class TestTermVectors : LuceneTestCase
         private static IndexReader reader;
         private static Directory directory;
 
-        /// <summary>
-        /// LUCENENET specific
-        /// Is non-static because NewIndexWriterConfig is no longer static.
-        /// </summary>
         [OneTimeSetUp]
         public override void OneTimeSetUp()
         {