You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2017/06/30 09:03:57 UTC
[2/3] lucenenet git commit: LUCENENET-438: Replaced all {@link } and
{@code } references with their c# counterparts.
LUCENENET-438: Replaced all {@link } and {@code } references with their c# counterparts.
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/db3d0238
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/db3d0238
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/db3d0238
Branch: refs/heads/master
Commit: db3d02385f60173d2d55ca8484962884ae3db5f4
Parents: 94b1a59
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Thu Jun 29 05:46:44 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Thu Jun 29 19:00:33 2017 +0700
----------------------------------------------------------------------
.../Miscellaneous/ASCIIFoldingFilter.cs | 10 ++--
.../Language/Nysiis.cs | 10 ++--
src/Lucene.Net.Codecs/Bloom/FuzzySet.cs | 2 +-
.../Classic/QueryParser.cs | 4 +-
.../Flexible/Core/Nodes/QueryNodeImpl.cs | 8 +--
.../Flexible/Standard/StandardQueryParser.cs | 2 +-
.../Analysis/CannedBinaryTokenStream.cs | 5 +-
.../Analysis/MockAnalyzer.cs | 8 +--
.../Analysis/MockTokenizer.cs | 3 +-
.../Bloom/TestBloomFilteredLucene41Postings.cs | 4 +-
.../Codecs/Lucene40/Lucene40PostingsWriter.cs | 4 +-
.../Codecs/MockSep/MockSingleIntIndexInput.cs | 6 +-
.../JavaCompatibility/LuceneTestCase.cs | 30 +++++-----
.../Randomized/Randomness.cs | 4 +-
.../Search/AssertingIndexSearcher.cs | 4 +-
.../Store/MockDirectoryWrapper.cs | 4 +-
.../Util/LuceneTestCase.cs | 14 ++---
.../Util/VirtualMethod.cs | 26 ++++-----
.../Language/Bm/BeiderMorseEncoderTest.cs | 2 +-
.../Bm/PhoneticEnginePerformanceTest.cs | 2 +-
.../ClassificationTestBase.cs | 2 +-
.../KNearestNeighborClassifierTest.cs | 2 +-
.../SimpleNaiveBayesClassifierTest.cs | 2 +-
.../Utils/DataSplitterTest.cs | 2 +-
.../Custom/HighlightCustomQueryTest.cs | 4 +-
.../TestMultiTermHighlighting.cs | 2 +-
.../Function/TestLongNormValueSource.cs | 14 ++---
.../Precedence/TestPrecedenceQueryParser.cs | 6 +-
.../Prefix/SpatialOpRecursivePrefixTreeTest.cs | 2 +-
src/Lucene.Net.Tests.Spatial/SpatialExample.cs | 6 +-
.../Analyzing/AnalyzingInfixSuggesterTest.cs | 8 ++-
.../Suggest/LookupBenchmarkTest.cs | 2 +-
.../Search/Similarities/TestSimilarityBase.cs | 60 ++++++++++----------
.../Search/TestTimeLimitingCollector.cs | 2 +-
src/Lucene.Net/Codecs/CodecUtil.cs | 2 +-
.../Codecs/MultiLevelSkipListWriter.cs | 2 +-
src/Lucene.Net/Index/LogMergePolicy.cs | 6 +-
src/Lucene.Net/Util/OpenBitSet.cs | 6 +-
src/Lucene.Net/Util/QueryBuilder.cs | 2 +-
39 files changed, 142 insertions(+), 142 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/ASCIIFoldingFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/ASCIIFoldingFilter.cs b/src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/ASCIIFoldingFilter.cs
index f735ef7..bf15afd 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/ASCIIFoldingFilter.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Miscellaneous/ASCIIFoldingFilter.cs
@@ -155,14 +155,16 @@ namespace Lucene.Net.Analysis.Miscellaneous
/// <summary>
/// Converts characters above ASCII to their ASCII equivalents. For example,
- /// accents are removed from accented characters. </summary>
+ /// accents are removed from accented characters.
+ /// <para/>
+ /// @lucene.internal
+ /// </summary>
/// <param name="input"> The characters to fold </param>
/// <param name="inputPos"> Index of the first character to fold </param>
- /// <param name="output"> The result of the folding. Should be of size >= {@code length * 4}. </param>
+ /// <param name="output"> The result of the folding. Should be of size >= <c>length * 4</c>. </param>
/// <param name="outputPos"> Index of output where to put the result of the folding </param>
/// <param name="length"> The number of characters to fold </param>
- /// <returns> length of output
- /// @lucene.internal </returns>
+ /// <returns> length of output </returns>
public static int FoldToASCII(char[] input, int inputPos, char[] output, int outputPos, int length)
{
int end = inputPos + length;
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Analysis.Phonetic/Language/Nysiis.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Phonetic/Language/Nysiis.cs b/src/Lucene.Net.Analysis.Phonetic/Language/Nysiis.cs
index a80d4f4..85eb24a 100644
--- a/src/Lucene.Net.Analysis.Phonetic/Language/Nysiis.cs
+++ b/src/Lucene.Net.Analysis.Phonetic/Language/Nysiis.cs
@@ -222,7 +222,7 @@ namespace Lucene.Net.Analysis.Phonetic.Language
}
/// <summary>
- /// Create an instance of the {@link Nysiis} encoder with the specified strict mode:
+ /// Create an instance of the <see cref="Nysiis"/> encoder with the specified strict mode:
/// <list type="bullet">
/// <item><term><c>true</c>:</term><description>encoded strings have a maximum length of 6</description></item>
/// <item><term><c>false</c>:</term><description>encoded strings may have arbitrary length</description></item>
@@ -237,14 +237,14 @@ namespace Lucene.Net.Analysis.Phonetic.Language
// LUCENENET specific - in .NET we don't need an object overload, since strings are sealed anyway.
// /**
// * Encodes an Object using the NYSIIS algorithm. This method is provided in order to satisfy the requirements of the
- // * Encoder interface, and will throw an {@link EncoderException} if the supplied object is not of type
- // * {@link String}.
+ // * Encoder interface, and will throw an <see cref="EncoderException"/> if the supplied object is not of type
+ // * <see cref="string"/>.
// *
// * @param obj
// * Object to encode
- // * @return An object (or a {@link String}) containing the NYSIIS code which corresponds to the given String.
+ // * @return An object (or a <see cref="string"/>) containing the NYSIIS code which corresponds to the given String.
// * @throws EncoderException
- // * if the parameter supplied is not of a {@link String}
+ // * if the parameter supplied is not of a <see cref="string"/>
// * @throws IllegalArgumentException
// * if a character is not mapped
// */
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Codecs/Bloom/FuzzySet.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Codecs/Bloom/FuzzySet.cs b/src/Lucene.Net.Codecs/Bloom/FuzzySet.cs
index 36a6f29..36b8989 100644
--- a/src/Lucene.Net.Codecs/Bloom/FuzzySet.cs
+++ b/src/Lucene.Net.Codecs/Bloom/FuzzySet.cs
@@ -177,7 +177,7 @@ namespace Lucene.Net.Codecs.Bloom
/// NumBitSetWords,BitSetWord<sup>NumBitSetWords</sup></description></item>
/// <item><description>HashFunctionName --> String (<see cref="DataOutput.WriteString(string)"/>) The
/// name of a ServiceProvider registered <see cref="HashFunction"/></description></item>
- /// <item><description>FuzzySetVersion --> Uint32 (<see cref="DataOutput.WriteInt32(int)"/>) The version number of the {@link FuzzySet} class</description></item>
+ /// <item><description>FuzzySetVersion --> Uint32 (<see cref="DataOutput.WriteInt32(int)"/>) The version number of the <see cref="FuzzySet"/> class</description></item>
/// <item><description>BloomSize --> Uint32 (<see cref="DataOutput.WriteInt32(int)"/>) The modulo value used
/// to project hashes into the field's Bitset</description></item>
/// <item><description>NumBitSetWords --> Uint32 (<see cref="DataOutput.WriteInt32(int)"/>) The number of
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.QueryParser/Classic/QueryParser.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Classic/QueryParser.cs b/src/Lucene.Net.QueryParser/Classic/QueryParser.cs
index 3a35db8..c71b1a7 100644
--- a/src/Lucene.Net.QueryParser/Classic/QueryParser.cs
+++ b/src/Lucene.Net.QueryParser/Classic/QueryParser.cs
@@ -102,8 +102,8 @@ namespace Lucene.Net.QueryParsers.Classic
{
// NOTE: This was moved into the QueryParserBase class.
- // * The default operator_Renamed for parsing queries.
- // * Use {@link QueryParser#setDefaultOperator} to change it.
+ // * The default operator for parsing queries.
+ // * Use <see cref="QueryParser.DefaultOperator"/> to change it.
// */
//public enum Operator
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.QueryParser/Flexible/Core/Nodes/QueryNodeImpl.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Core/Nodes/QueryNodeImpl.cs b/src/Lucene.Net.QueryParser/Flexible/Core/Nodes/QueryNodeImpl.cs
index 01321e5..e066c8d 100644
--- a/src/Lucene.Net.QueryParser/Flexible/Core/Nodes/QueryNodeImpl.cs
+++ b/src/Lucene.Net.QueryParser/Flexible/Core/Nodes/QueryNodeImpl.cs
@@ -225,10 +225,10 @@ namespace Lucene.Net.QueryParsers.Flexible.Core.Nodes
/// </summary>
/// <param name="fld">field name</param>
/// <returns>true if fld is the default field</returns>
- // TODO: remove this method, it's commonly used by {@link
- // #toQueryString(org.apache.lucene.queryParser.core.parser.EscapeQuerySyntax)}
- // to figure out what is the default field, however, {@link
- // #toQueryString(org.apache.lucene.queryParser.core.parser.EscapeQuerySyntax)}
+ // TODO: remove this method, it's commonly used by
+ // <see cref="ToQueryString(IEscapeQuerySyntax)"/>
+ // to figure out what is the default field, however,
+ // <see cref="ToQueryString(IEscapeQuerySyntax)"/>
// should receive the default field value directly by parameter
protected virtual bool IsDefaultField(string fld)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.QueryParser/Flexible/Standard/StandardQueryParser.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.QueryParser/Flexible/Standard/StandardQueryParser.cs b/src/Lucene.Net.QueryParser/Flexible/Standard/StandardQueryParser.cs
index dedcd9f..5768c36 100644
--- a/src/Lucene.Net.QueryParser/Flexible/Standard/StandardQueryParser.cs
+++ b/src/Lucene.Net.QueryParser/Flexible/Standard/StandardQueryParser.cs
@@ -445,7 +445,7 @@ namespace Lucene.Net.QueryParsers.Flexible.Standard
}
/// <summary>
- /// Sets the {@link Resolution} used for each field
+ /// Sets the <see cref="DateTools.Resolution"/> used for each field
/// </summary>
/// <param name="dateRes">a collection that maps a field to its <see cref="DateTools.Resolution"/></param>
[Obsolete("Use DateResolutionMap property instead.")]
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Analysis/CannedBinaryTokenStream.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Analysis/CannedBinaryTokenStream.cs b/src/Lucene.Net.TestFramework/Analysis/CannedBinaryTokenStream.cs
index 7d54f56..97a4d16 100644
--- a/src/Lucene.Net.TestFramework/Analysis/CannedBinaryTokenStream.cs
+++ b/src/Lucene.Net.TestFramework/Analysis/CannedBinaryTokenStream.cs
@@ -61,9 +61,8 @@ namespace Lucene.Net.Analysis
private readonly IOffsetAttribute OffsetAtt;// = addAttribute(typeof(OffsetAttribute));
/// <summary>
- /// An attribute extending {@link
- /// TermToBytesRefAttribute} but exposing {@link
- /// #setBytesRef} method.
+ /// An attribute extending <see cref="ITermToBytesRefAttribute"/>
+ /// but exposing <see cref="BytesRef"/> property.
/// </summary>
public interface IBinaryTermAttribute : ITermToBytesRefAttribute
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Analysis/MockAnalyzer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Analysis/MockAnalyzer.cs b/src/Lucene.Net.TestFramework/Analysis/MockAnalyzer.cs
index 88b6942..c09e31e 100644
--- a/src/Lucene.Net.TestFramework/Analysis/MockAnalyzer.cs
+++ b/src/Lucene.Net.TestFramework/Analysis/MockAnalyzer.cs
@@ -70,8 +70,7 @@ namespace Lucene.Net.Analysis
}
/// <summary>
- /// Calls {@link #MockAnalyzer(Random, CharacterRunAutomaton, boolean, CharacterRunAutomaton)
- /// MockAnalyzer(random, runAutomaton, lowerCase, MockTokenFilter.EMPTY_STOPSET, false}).
+ /// Calls <c>MockAnalyzer(random, runAutomaton, lowerCase, MockTokenFilter.EMPTY_STOPSET, false)</c>.
/// </summary>
public MockAnalyzer(Random random, CharacterRunAutomaton runAutomaton, bool lowerCase)
: this(random, runAutomaton, lowerCase, MockTokenFilter.EMPTY_STOPSET)
@@ -80,9 +79,8 @@ namespace Lucene.Net.Analysis
/// <summary>
/// Create a Whitespace-lowercasing analyzer with no stopwords removal.
- /// <p>
- /// Calls {@link #MockAnalyzer(Random, CharacterRunAutomaton, boolean, CharacterRunAutomaton)
- /// MockAnalyzer(random, MockTokenizer.WHITESPACE, true, MockTokenFilter.EMPTY_STOPSET, false}).
+ /// <para/>
+ /// Calls <c>MockAnalyzer(random, MockTokenizer.WHITESPACE, true, MockTokenFilter.EMPTY_STOPSET, false)</c>.
/// </summary>
public MockAnalyzer(Random random)
: this(random, MockTokenizer.WHITESPACE, true)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Analysis/MockTokenizer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Analysis/MockTokenizer.cs b/src/Lucene.Net.TestFramework/Analysis/MockTokenizer.cs
index 5a17331..8dcaabd 100644
--- a/src/Lucene.Net.TestFramework/Analysis/MockTokenizer.cs
+++ b/src/Lucene.Net.TestFramework/Analysis/MockTokenizer.cs
@@ -130,8 +130,7 @@ namespace Lucene.Net.Analysis
}
/// <summary>
- /// Calls {@link #MockTokenizer(Lucene.Net.Util.AttributeSource.AttributeFactory,SetReader,CharacterRunAutomaton,boolean)
- /// MockTokenizer(AttributeFactory, TextReader, WHITESPACE, true)}
+ /// Calls <c>MockTokenizer(AttributeFactory, TextReader, WHITESPACE, true)</c>
/// </summary>
public MockTokenizer(AttributeFactory factory, TextReader input)
: this(input, WHITESPACE, true)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Codecs/Bloom/TestBloomFilteredLucene41Postings.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Bloom/TestBloomFilteredLucene41Postings.cs b/src/Lucene.Net.TestFramework/Codecs/Bloom/TestBloomFilteredLucene41Postings.cs
index 164db03..b4b9c9b 100644
--- a/src/Lucene.Net.TestFramework/Codecs/Bloom/TestBloomFilteredLucene41Postings.cs
+++ b/src/Lucene.Net.TestFramework/Codecs/Bloom/TestBloomFilteredLucene41Postings.cs
@@ -21,9 +21,9 @@ namespace Lucene.Net.Codecs.Bloom
*/
/// <summary>
- /// A class used for testing {@link BloomFilteringPostingsFormat} with a concrete
+ /// A class used for testing <see cref="BloomFilteringPostingsFormat"/> with a concrete
/// delegate (Lucene41). Creates a Bloom filter on ALL fields and with tiny
- /// amounts of memory reserved for the filter.DO NOT USE IN A PRODUCTION
+ /// amounts of memory reserved for the filter. DO NOT USE IN A PRODUCTION
/// APPLICATION This is not a realistic application of Bloom Filters as they
/// ordinarily are larger and operate on only primary key type fields.
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Codecs/Lucene40/Lucene40PostingsWriter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/Lucene40/Lucene40PostingsWriter.cs b/src/Lucene.Net.TestFramework/Codecs/Lucene40/Lucene40PostingsWriter.cs
index 4ae4a18..2b1a7b7 100644
--- a/src/Lucene.Net.TestFramework/Codecs/Lucene40/Lucene40PostingsWriter.cs
+++ b/src/Lucene.Net.TestFramework/Codecs/Lucene40/Lucene40PostingsWriter.cs
@@ -100,8 +100,8 @@ namespace Lucene.Net.Codecs.Lucene40
}
/// <summary>
- /// Creates a <seealso cref="Lucene40PostingsWriter"/>, with the
- /// specified {@code skipInterval}.
+ /// Creates a <see cref="Lucene40PostingsWriter"/>, with the
+ /// specified <paramref name="skipInterval"/>.
/// </summary>
public Lucene40PostingsWriter(SegmentWriteState state, int skipInterval)
: base()
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Codecs/MockSep/MockSingleIntIndexInput.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Codecs/MockSep/MockSingleIntIndexInput.cs b/src/Lucene.Net.TestFramework/Codecs/MockSep/MockSingleIntIndexInput.cs
index 33a63e0..da9f070 100644
--- a/src/Lucene.Net.TestFramework/Codecs/MockSep/MockSingleIntIndexInput.cs
+++ b/src/Lucene.Net.TestFramework/Codecs/MockSep/MockSingleIntIndexInput.cs
@@ -21,11 +21,11 @@ namespace Lucene.Net.Codecs.MockSep
*/
/// <summary>
- /// Reads IndexInputs written with {@link
- /// MockSingleIntIndexOutput}. NOTE: this class is just for
+ /// Reads IndexInputs written with
+ /// <see cref="MockSingleIntIndexOutput"/>. NOTE: this class is just for
/// demonstration purposes(it is a very slow way to read a
/// block of ints).
- ///
+ /// <para/>
/// @lucene.experimental
/// </summary>
public class MockSingleIntIndexInput : Int32IndexInput
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/JavaCompatibility/LuceneTestCase.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/JavaCompatibility/LuceneTestCase.cs b/src/Lucene.Net.TestFramework/JavaCompatibility/LuceneTestCase.cs
index cdacae4..a6b1bb2 100644
--- a/src/Lucene.Net.TestFramework/JavaCompatibility/LuceneTestCase.cs
+++ b/src/Lucene.Net.TestFramework/JavaCompatibility/LuceneTestCase.cs
@@ -199,17 +199,17 @@ namespace Lucene.Net.Util
/**
* Returns the next pseudorandom, Gaussian ("normally") distributed
- * {@code double} value with mean {@code 0.0} and standard
- * deviation {@code 1.0} from this random number generator's sequence.
- * <p>
- * The general contract of {@code nextGaussian} is that one
- * {@code double} value, chosen from (approximately) the usual
- * normal distribution with mean {@code 0.0} and standard deviation
- * {@code 1.0}, is pseudorandomly generated and returned.
+ * <c>double</c> value with mean <c>0.0</c> and standard
+ * deviation <c>1.0</c> from this random number generator's sequence.
+ * <para/>
+ * The general contract of <c>nextGaussian</c> is that one
+ * <c>double</c> value, chosen from (approximately) the usual
+ * normal distribution with mean <c>0.0</c> and standard deviation
+ * <c>1.0</c>, is pseudorandomly generated and returned.
*
- * <p>The method {@code nextGaussian} is implemented by class
- * {@code Random} as if by a threadsafe version of the following:
- * <pre> {@code
+ * <para/>The method <c>nextGaussian</c> is implemented by class
+ * <c>Random</c> as if by a threadsafe version of the following:
+ * <code>
* private double nextNextGaussian;
* private boolean haveNextNextGaussian = false;
*
@@ -229,17 +229,17 @@ namespace Lucene.Net.Util
* haveNextNextGaussian = true;
* return v1 * multiplier;
* }
- * }}</pre>
+ * }}</code>
* This uses the <i>polar method</i> of G. E. P. Box, M. E. Muller, and
* G. Marsaglia, as described by Donald E. Knuth in <i>The Art of
* Computer Programming</i>, Volume 3: <i>Seminumerical Algorithms</i>,
* section 3.4.1, subsection C, algorithm P. Note that it generates two
- * independent values at the cost of only one call to {@code StrictMath.log}
- * and one call to {@code StrictMath.sqrt}.
+ * independent values at the cost of only one call to <c>StrictMath.log</c>
+ * and one call to <c>StrictMath.sqrt</c>.
*
* @return the next pseudorandom, Gaussian ("normally") distributed
- * {@code double} value with mean {@code 0.0} and
- * standard deviation {@code 1.0} from this random number
+ * <c>double</c> value with mean <c>0.0</c> and
+ * standard deviation <c>1.0</c> from this random number
* generator's sequence
*/
public double randomGaussian()
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Randomized/Randomness.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Randomized/Randomness.cs b/src/Lucene.Net.TestFramework/Randomized/Randomness.cs
index d3b3bd6..8f4efd5 100644
--- a/src/Lucene.Net.TestFramework/Randomized/Randomness.cs
+++ b/src/Lucene.Net.TestFramework/Randomized/Randomness.cs
@@ -28,11 +28,11 @@ namespace Lucene.Net.Randomized
/// </summary>
/// <remarks>
/// <para>
- /// An instance of this class will be typically available from {@link RandomizedContext}.
+ /// An instance of this class will be typically available from <see cref="RandomizedContext"/>.
/// No need to instantiate manually.
/// </para>
/// </remarks>
- /// <see cref="Lucene.Net.Randomized.RandomContext"/>
+ /// <see cref="Lucene.Net.Randomized.RandomizedContext"/>
/// <see cref="Lucene.Net.Randomized.SingleThreadedRandom"/>
public class Randomness : IDisposable
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Search/AssertingIndexSearcher.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Search/AssertingIndexSearcher.cs b/src/Lucene.Net.TestFramework/Search/AssertingIndexSearcher.cs
index 953bc6b..c0b067b 100644
--- a/src/Lucene.Net.TestFramework/Search/AssertingIndexSearcher.cs
+++ b/src/Lucene.Net.TestFramework/Search/AssertingIndexSearcher.cs
@@ -30,7 +30,7 @@ namespace Lucene.Net.Search
/// <summary>
/// Helper class that adds some extra checks to ensure correct
- /// usage of {@code IndexSearcher} and {@code Weight}.
+ /// usage of <see cref="IndexSearcher"/> and <see cref="Weight"/>.
/// </summary>
public class AssertingIndexSearcher : IndexSearcher
{
@@ -61,7 +61,7 @@ namespace Lucene.Net.Search
}
/// <summary>
- /// Ensures, that the returned {@code Weight} is not normalized again, which may produce wrong scores. </summary>
+ /// Ensures, that the returned <see cref="Weight"/> is not normalized again, which may produce wrong scores. </summary>
public override Weight CreateNormalizedWeight(Query query)
{
Weight w = base.CreateNormalizedWeight(query);
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Store/MockDirectoryWrapper.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Store/MockDirectoryWrapper.cs b/src/Lucene.Net.TestFramework/Store/MockDirectoryWrapper.cs
index c87714a..a333d93 100644
--- a/src/Lucene.Net.TestFramework/Store/MockDirectoryWrapper.cs
+++ b/src/Lucene.Net.TestFramework/Store/MockDirectoryWrapper.cs
@@ -1446,8 +1446,8 @@ namespace Lucene.Net.Store
}
/// <summary>
- /// Use this when throwing fake {@codeSystem.IO.IOException},
- /// e.g. from <seealso cref="MockDirectoryWrapper.Failure"/>.
+ /// Use this when throwing fake <see cref="System.IO.IOException"/>,
+ /// e.g. from <see cref="MockDirectoryWrapper.Failure"/>.
/// </summary>
public class FakeIOException : System.IO.IOException
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Util/LuceneTestCase.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Util/LuceneTestCase.cs b/src/Lucene.Net.TestFramework/Util/LuceneTestCase.cs
index 9592653..74f9c8e 100644
--- a/src/Lucene.Net.TestFramework/Util/LuceneTestCase.cs
+++ b/src/Lucene.Net.TestFramework/Util/LuceneTestCase.cs
@@ -419,10 +419,10 @@ namespace Lucene.Net.Util
// -----------------------------------------------------------------
/// <summary>
- /// When {@code true}, Codecs for old Lucene version will support writing
- /// indexes in that format. Defaults to {@code false}, can be disabled by
+ /// When <c>true</c>, Codecs for old Lucene version will support writing
+ /// indexes in that format. Defaults to <c>false</c>, can be disabled by
/// specific tests on demand.
- ///
+ /// <para/>
/// @lucene.internal
/// </summary>
public static bool OLD_FORMAT_IMPERSONATION_IS_ACTIVE = false;
@@ -582,7 +582,7 @@ namespace Lucene.Net.Util
// -----------------------------------------------------------------
/// <summary>
- /// For subclasses to override. Overrides must call {@code super.setUp()}.
+ /// For subclasses to override. Overrides must call <c>base.SetUp()</c>.
/// </summary>
[SetUp]
public virtual void SetUp()
@@ -613,7 +613,7 @@ namespace Lucene.Net.Util
}
/// <summary>
- /// For subclasses to override. Overrides must call {@code super.tearDown()}.
+ /// For subclasses to override. Overrides must call <c>base.TearDown()</c>.
/// </summary>
[TearDown]
public virtual void TearDown()
@@ -1798,9 +1798,9 @@ namespace Lucene.Net.Util
}
/// <summary>
- /// Gets a resource from the classpath as <seealso cref="File"/>. this method should only
+ /// Gets a resource from the classpath as <see cref="Stream"/>. This method should only
/// be used, if a real file is needed. To get a stream, code should prefer
- /// <seealso cref="Class#getResourceAsStream"/> using {@code this.getClass()}.
+ /// <see cref="Type.getResourceAsStream"/> using <c>this.GetType()</c>.
/// </summary>
protected Stream GetDataFile(string name)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.TestFramework/Util/VirtualMethod.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.TestFramework/Util/VirtualMethod.cs b/src/Lucene.Net.TestFramework/Util/VirtualMethod.cs
index c85cf17..6d6be26 100644
--- a/src/Lucene.Net.TestFramework/Util/VirtualMethod.cs
+++ b/src/Lucene.Net.TestFramework/Util/VirtualMethod.cs
@@ -33,7 +33,7 @@ namespace Lucene.Net.Util
/// If somebody still overrides the deprecated method in a non-final class,
/// you must keep track, of this and maybe delegate to the old method in the subclass.
/// The cost of reflection is minimized by the following usage of this class:</p>
- /// <p>Define <strong>static final</strong> fields in the base class ({@code BaseClass}),
+ /// <p>Define <strong>static final</strong> fields in the base class (<c>BaseClass</c>),
/// where the old and new method are declared:</p>
/// <pre class="prettyprint">
/// static final VirtualMethod<BaseClass> newMethod =
@@ -42,7 +42,7 @@ namespace Lucene.Net.Util
/// new VirtualMethod<BaseClass>(BaseClass.class, "oldName", parameters...);
/// </pre>
/// <p>this enforces the singleton status of these objects, as the maintenance of the cache would be too costly else.
- /// If you try to create a second instance of for the same method/{@code baseClass} combination, an exception is thrown.</p>
+ /// If you try to create a second instance of for the same method/<c>baseClass</c> combination, an exception is thrown.</p>
/// <p>To detect if e.g. the old method was overridden by a more far subclass on the inheritance path to the current
/// instance's class, use a <strong>non-static</strong> field:</p>
/// <pre class="prettyprint">
@@ -56,7 +56,7 @@ namespace Lucene.Net.Util
/// <p><seealso cref="GetImplementationDistance"/> returns the distance of the subclass that overrides this method.
/// The one with the larger distance should be used preferable.
/// this way also more complicated method rename scenarios can be handled
- /// (think of 2.9 {@code TokenStream} deprecations).</p>
+ /// (think of 2.9 <see cref="Analysis.TokenStream"/> deprecations).</p>
///
/// @lucene.internal
/// </summary>
@@ -72,10 +72,10 @@ namespace Lucene.Net.Util
private readonly WeakIdentityMap<Type, int> Cache = WeakIdentityMap<Type, int>.NewConcurrentHashMap(false);
/// <summary>
- /// Creates a new instance for the given {@code baseClass} and method declaration. </summary>
+ /// Creates a new instance for the given <c>baseClass</c> and method declaration. </summary>
/// <exception cref="InvalidOperationException"> if you create a second instance of the same
- /// {@code baseClass} and method declaration combination. this enforces the singleton status. </exception>
- /// <exception cref="ArgumentException"> if {@code baseClass} does not declare the given method. </exception>
+ /// <c>baseClass</c> and method declaration combination. this enforces the singleton status. </exception>
+ /// <exception cref="ArgumentException"> if <c>baseClass</c> does not declare the given method. </exception>
public VirtualMethod(Type baseClass, string method, params Type[] parameters)
{
this.BaseClass = baseClass;
@@ -100,8 +100,8 @@ namespace Lucene.Net.Util
}
/// <summary>
- /// Returns the distance from the {@code baseClass} in which this method is overridden/implemented
- /// in the inheritance path between {@code baseClass} and the given subclass {@code subclazz}. </summary>
+ /// Returns the distance from the <c>baseClass</c> in which this method is overridden/implemented
+ /// in the inheritance path between <c>baseClass</c> and the given subclass <c>subclazz</c>. </summary>
/// <returns> 0 iff not overridden, else the distance to the base class </returns>
public int GetImplementationDistance(Type subclazz)
{
@@ -116,10 +116,10 @@ namespace Lucene.Net.Util
/// <summary>
/// Returns, if this method is overridden/implemented in the inheritance path between
- /// {@code baseClass} and the given subclass {@code subclazz}.
- /// <p>You can use this method to detect if a method that should normally be final was overridden
+ /// <c>baseClass</c> and the given subclass <paramref name="subclazz"/>.
+ /// <para/>You can use this method to detect if a method that should normally be final was overridden
/// by the given instance's class. </summary>
- /// <returns> {@code false} iff not overridden </returns>
+ /// <returns> <c>false</c> iff not overridden </returns>
public bool IsOverriddenAsOf(Type subclazz)
{
return GetImplementationDistance(subclazz) > 0;
@@ -158,8 +158,8 @@ namespace Lucene.Net.Util
/// <summary>
/// Utility method that compares the implementation/override distance of two methods. </summary>
/// <returns> <ul>
- /// <li>> 1, iff {@code m1} is overridden/implemented in a subclass of the class overriding/declaring {@code m2}
- /// <li>< 1, iff {@code m2} is overridden in a subclass of the class overriding/declaring {@code m1}
+ /// <li>> 1, iff <paramref name="m1"/> is overridden/implemented in a subclass of the class overriding/declaring <paramref name="m2"/>
+ /// <li>< 1, iff <paramref name="m2"/> is overridden in a subclass of the class overriding/declaring <paramref name="m1"/>
/// <li>0, iff both methods are overridden in the same class (or are not overridden at all)
/// </ul> </returns>
public static int CompareImplementationDistance(Type clazz, VirtualMethod m1, VirtualMethod m2)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/BeiderMorseEncoderTest.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/BeiderMorseEncoderTest.cs b/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/BeiderMorseEncoderTest.cs
index bd3681b..1d7fe8a 100644
--- a/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/BeiderMorseEncoderTest.cs
+++ b/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/BeiderMorseEncoderTest.cs
@@ -207,7 +207,7 @@ namespace Lucene.Net.Analysis.Phonetic.Language.Bm
}
/**
- * (Un)luckily, the worse performing test because of the data in {@link #TEST_CHARS}
+ * (Un)luckily, the worse performing test because of the data in <see cref="TEST_CHARS"/>
*
* @throws EncoderException
*/
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/PhoneticEnginePerformanceTest.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/PhoneticEnginePerformanceTest.cs b/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/PhoneticEnginePerformanceTest.cs
index 7b8b400..69f36e9 100644
--- a/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/PhoneticEnginePerformanceTest.cs
+++ b/src/Lucene.Net.Tests.Analysis.Phonetic/Language/Bm/PhoneticEnginePerformanceTest.cs
@@ -21,7 +21,7 @@ namespace Lucene.Net.Analysis.Phonetic.Language.Bm
*/
/**
- * Tests performance for {@link PhoneticEngine}.
+ * Tests performance for <see cref="PhoneticEngine"/>.
* <p>
* See <a href="https://issues.apache.org/jira/browse/CODEC-174">[CODEC-174] Improve performance of Beider Morse
* encoder</a>.
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Classification/ClassificationTestBase.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Classification/ClassificationTestBase.cs b/src/Lucene.Net.Tests.Classification/ClassificationTestBase.cs
index 6fb483d..ebb20ac 100644
--- a/src/Lucene.Net.Tests.Classification/ClassificationTestBase.cs
+++ b/src/Lucene.Net.Tests.Classification/ClassificationTestBase.cs
@@ -31,7 +31,7 @@ namespace Lucene.Net.Classification
{
/**
- * Base class for testing {@link Classifier}s
+ * Base class for testing <see cref="IClassifier{T}"/>s
*/
public abstract class ClassificationTestBase<T> : Util.LuceneTestCase
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Classification/KNearestNeighborClassifierTest.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Classification/KNearestNeighborClassifierTest.cs b/src/Lucene.Net.Tests.Classification/KNearestNeighborClassifierTest.cs
index 0a69365..97efcd9 100644
--- a/src/Lucene.Net.Tests.Classification/KNearestNeighborClassifierTest.cs
+++ b/src/Lucene.Net.Tests.Classification/KNearestNeighborClassifierTest.cs
@@ -24,7 +24,7 @@ using NUnit.Framework;
namespace Lucene.Net.Classification
{
/**
- * Testcase for {@link KNearestNeighborClassifier}
+ * Testcase for <see cref="KNearestNeighborClassifier"/>
*/
public class KNearestNeighborClassifierTest : ClassificationTestBase<BytesRef>
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Classification/SimpleNaiveBayesClassifierTest.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Classification/SimpleNaiveBayesClassifierTest.cs b/src/Lucene.Net.Tests.Classification/SimpleNaiveBayesClassifierTest.cs
index 0af9673..d4089fb 100644
--- a/src/Lucene.Net.Tests.Classification/SimpleNaiveBayesClassifierTest.cs
+++ b/src/Lucene.Net.Tests.Classification/SimpleNaiveBayesClassifierTest.cs
@@ -28,7 +28,7 @@ namespace Lucene.Net.Classification
*/
/**
- * Testcase for {@link SimpleNaiveBayesClassifier}
+ * Testcase for <see cref="SimpleNaiveBayesClassifier"/>
*/
// TODO : eventually remove this if / when fallback methods exist for all un-supportable codec methods (see LUCENE-4872)
[SuppressCodecs("Lucene3x")]
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Classification/Utils/DataSplitterTest.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Classification/Utils/DataSplitterTest.cs b/src/Lucene.Net.Tests.Classification/Utils/DataSplitterTest.cs
index 4dc0a69..4ff3b24 100644
--- a/src/Lucene.Net.Tests.Classification/Utils/DataSplitterTest.cs
+++ b/src/Lucene.Net.Tests.Classification/Utils/DataSplitterTest.cs
@@ -28,7 +28,7 @@ using NUnit.Framework;
namespace Lucene.Net.Classification
{
/**
- * Testcase for {@link org.apache.lucene.classification.utils.DatasetSplitter}
+ * Testcase for <see cref="DatasetSplitter"/>
*/
public class DataSplitterTest : Util.LuceneTestCase
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Highlighter/Highlight/Custom/HighlightCustomQueryTest.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Highlighter/Highlight/Custom/HighlightCustomQueryTest.cs b/src/Lucene.Net.Tests.Highlighter/Highlight/Custom/HighlightCustomQueryTest.cs
index 481e15a..9f65d4d 100644
--- a/src/Lucene.Net.Tests.Highlighter/Highlight/Custom/HighlightCustomQueryTest.cs
+++ b/src/Lucene.Net.Tests.Highlighter/Highlight/Custom/HighlightCustomQueryTest.cs
@@ -25,8 +25,8 @@ namespace Lucene.Net.Search.Highlight.Custom
*/
/// <summary>
- /// Tests the extensibility of {@link WeightedSpanTermExtractor} and
- /// {@link QueryScorer} in a user defined package
+ /// Tests the extensibility of <see cref="WeightedSpanTermExtractor"/> and
+ /// <see cref="QueryScorer"/> in a user defined package
/// </summary>
public class HighlightCustomQueryTest : LuceneTestCase
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Highlighter/PostingsHighlight/TestMultiTermHighlighting.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Highlighter/PostingsHighlight/TestMultiTermHighlighting.cs b/src/Lucene.Net.Tests.Highlighter/PostingsHighlight/TestMultiTermHighlighting.cs
index a8497d6..eeb6d47 100644
--- a/src/Lucene.Net.Tests.Highlighter/PostingsHighlight/TestMultiTermHighlighting.cs
+++ b/src/Lucene.Net.Tests.Highlighter/PostingsHighlight/TestMultiTermHighlighting.cs
@@ -35,7 +35,7 @@ namespace Lucene.Net.Search.PostingsHighlight
*/
/// <summary>
- /// Some tests that override {@link PostingsHighlighter#getIndexAnalyzer} to
+ /// Some tests that override <see cref="PostingsHighlighter.GetIndexAnalyzer(string)"/> to
/// highlight wilcard, fuzzy, etc queries.
/// </summary>
[SuppressCodecs("MockFixedIntBlock", "MockVariableIntBlock", "MockSep", "MockRandom", "Lucene3x")]
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Queries/Function/TestLongNormValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Queries/Function/TestLongNormValueSource.cs b/src/Lucene.Net.Tests.Queries/Function/TestLongNormValueSource.cs
index 4c937cd..159dff9 100644
--- a/src/Lucene.Net.Tests.Queries/Function/TestLongNormValueSource.cs
+++ b/src/Lucene.Net.Tests.Queries/Function/TestLongNormValueSource.cs
@@ -169,13 +169,13 @@ namespace Lucene.Net.Tests.Queries.Function
/// <summary>
/// Implemented as
- /// <code>state.getBoost()*lengthNorm(numTerms)</code>, where
- /// <code>numTerms</code> is <seealso cref="FieldInvertState#getLength()"/> if {@link
- /// #setDiscountOverlaps} is false, else it's {@link
- /// org.apache.lucene.index.FieldInvertState#getLength()} - {@link
- /// org.apache.lucene.index.FieldInvertState#getNumOverlap()}.
- ///
- /// @lucene.experimental
+ /// <c>state.Boost*LengthNorm(numTerms)</c>, where
+ /// <c>numTerms</c> is <see cref="FieldInvertState.Length"/> if
+ /// <see cref="DiscountOverlaps"/># is false, else it's
+ /// <see cref="FieldInvertState.Length"/> -
+ /// <see cref="FieldInvertState.NumOverlap"/>.
+ /// <para/>
+ /// @lucene.experimental
/// </summary>
public override float LengthNorm(FieldInvertState state)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.QueryParser/Flexible/Precedence/TestPrecedenceQueryParser.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.QueryParser/Flexible/Precedence/TestPrecedenceQueryParser.cs b/src/Lucene.Net.Tests.QueryParser/Flexible/Precedence/TestPrecedenceQueryParser.cs
index fe62cda..8a7e3eb 100644
--- a/src/Lucene.Net.Tests.QueryParser/Flexible/Precedence/TestPrecedenceQueryParser.cs
+++ b/src/Lucene.Net.Tests.QueryParser/Flexible/Precedence/TestPrecedenceQueryParser.cs
@@ -34,12 +34,12 @@ namespace Lucene.Net.QueryParsers.Flexible.Precedence
*/
/// <summary>
- /// This test case tests {@link PrecedenceQueryParser}.
+ /// This test case tests <see cref="PrecedenceQueryParser"/>.
/// <para/>
- /// It contains all tests from {@link QueryParserTestBase}
+ /// It contains all tests from <see cref="Util.QueryParserTestBase"/>
/// with some adjusted to fit the precedence requirement, plus some precedence test cases.
/// </summary>
- /// <seealso cref="QueryParserTestBase"/>
+ /// <see cref="Util.QueryParserTestBase"/>
//TODO: refactor this to actually extend that class, overriding the tests
//that it adjusts to fit the precedence requirement, adding its extra tests.
public class TestPrecedenceQueryParser : LuceneTestCase
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Spatial/Prefix/SpatialOpRecursivePrefixTreeTest.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Spatial/Prefix/SpatialOpRecursivePrefixTreeTest.cs b/src/Lucene.Net.Tests.Spatial/Prefix/SpatialOpRecursivePrefixTreeTest.cs
index e939887..21bdb50 100644
--- a/src/Lucene.Net.Tests.Spatial/Prefix/SpatialOpRecursivePrefixTreeTest.cs
+++ b/src/Lucene.Net.Tests.Spatial/Prefix/SpatialOpRecursivePrefixTreeTest.cs
@@ -120,7 +120,7 @@ namespace Lucene.Net.Spatial.Prefix
doTest(SpatialOperation.IsDisjointTo);
}
- /** See LUCENE-5062, {@link ContainsPrefixTreeFilter#multiOverlappingIndexedShapes}. */
+ /** See LUCENE-5062, <see cref="ContainsPrefixTreeFilter.m_multiOverlappingIndexedShapes"/>. */
[Test, Repeat(ITERATIONS)]
public virtual void TestContainsPairOverlap()
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Spatial/SpatialExample.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Spatial/SpatialExample.cs b/src/Lucene.Net.Tests.Spatial/SpatialExample.cs
index 25bc0d5..b60525b 100644
--- a/src/Lucene.Net.Tests.Spatial/SpatialExample.cs
+++ b/src/Lucene.Net.Tests.Spatial/SpatialExample.cs
@@ -56,15 +56,15 @@ namespace Lucene.Net.Spatial
}
/**
- * The Spatial4j {@link SpatialContext} is a sort of global-ish singleton
+ * The Spatial4j <see cref="SpatialContext"/> is a sort of global-ish singleton
* needed by Lucene spatial. It's a facade to the rest of Spatial4j, acting
- * as a factory for {@link Shape}s and provides access to reading and writing
+ * as a factory for <see cref="IShape"/>s and provides access to reading and writing
* them from Strings.
*/
private SpatialContext ctx;//"ctx" is the conventional variable name
/**
- * The Lucene spatial {@link SpatialStrategy} encapsulates an approach to
+ * The Lucene spatial <see cref="SpatialStrategy"/> encapsulates an approach to
* indexing and searching shapes, and providing distance values for them.
* It's a simple API to unify different approaches. You might use more than
* one strategy for a shape as each strategy has its strengths and weaknesses.
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Suggest/Suggest/Analyzing/AnalyzingInfixSuggesterTest.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Suggest/Suggest/Analyzing/AnalyzingInfixSuggesterTest.cs b/src/Lucene.Net.Tests.Suggest/Suggest/Analyzing/AnalyzingInfixSuggesterTest.cs
index 07b4f6e..e134035 100644
--- a/src/Lucene.Net.Tests.Suggest/Suggest/Analyzing/AnalyzingInfixSuggesterTest.cs
+++ b/src/Lucene.Net.Tests.Suggest/Suggest/Analyzing/AnalyzingInfixSuggesterTest.cs
@@ -108,11 +108,13 @@ namespace Lucene.Net.Search.Suggest.Analyzing
suggester.Dispose();
}
- /** Used to return highlighted result; see {@link
- * LookupResult#highlightKey} */
+ /// <summary>
+ /// Used to return highlighted result; see
+ /// <see cref = "Lookup.LookupResult.HighlightKey" />
+ /// </summary>
private sealed class LookupHighlightFragment
{
- /** Portion of text for this fragment. */
+ /// <summary>Portion of text for this fragment.</summary>
public readonly string text;
/** True if this text matched a part of the user's
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests.Suggest/Suggest/LookupBenchmarkTest.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests.Suggest/Suggest/LookupBenchmarkTest.cs b/src/Lucene.Net.Tests.Suggest/Suggest/LookupBenchmarkTest.cs
index f3d84d1..993e995 100644
--- a/src/Lucene.Net.Tests.Suggest/Suggest/LookupBenchmarkTest.cs
+++ b/src/Lucene.Net.Tests.Suggest/Suggest/LookupBenchmarkTest.cs
@@ -163,7 +163,7 @@ namespace Lucene.Net.Search.Suggest
}
/**
- * Create {@link Lookup} instance and populate it.
+ * Create <see cref="Lookup"/> instance and populate it.
*/
internal Lookup BuildLookup(Type cls, Input[] input)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests/Search/Similarities/TestSimilarityBase.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests/Search/Similarities/TestSimilarityBase.cs b/src/Lucene.Net.Tests/Search/Similarities/TestSimilarityBase.cs
index 28ef7b4..1fd532c 100644
--- a/src/Lucene.Net.Tests/Search/Similarities/TestSimilarityBase.cs
+++ b/src/Lucene.Net.Tests/Search/Similarities/TestSimilarityBase.cs
@@ -37,30 +37,30 @@ namespace Lucene.Net.Search.Similarities
using TextField = TextField;
/// <summary>
- /// Tests the <seealso cref="SimilarityBase"/>-based Similarities. Contains unit tests and
+ /// Tests the <see cref="SimilarityBase"/>-based Similarities. Contains unit tests and
/// integration tests for all Similarities and correctness tests for a select
/// few.
- /// <p>this class maintains a list of
- /// {@code SimilarityBase} subclasses. Each test case performs its test on all
+ /// <para>this class maintains a list of
+ /// <see cref="SimilarityBase"/> subclasses. Each test case performs its test on all
/// items in the list. If a test case fails, the name of the Similarity that
- /// caused the failure is returned as part of the assertion error message.</p>
- /// <p>Unit testing is performed by constructing statistics manually and calling
- /// the <seealso cref="SimilarityBase#score(BasicStats, float, float)"/> method of the
+ /// caused the failure is returned as part of the assertion error message.</para>
+ /// <para>Unit testing is performed by constructing statistics manually and calling
+ /// the <see cref="SimilarityBase.Score(BasicStats, float, float)"/> method of the
/// Similarities. The statistics represent corner cases of corpus distributions.
- /// </p>
- /// <p>For the integration tests, a small (8-document) collection is indexed. The
+ /// </para>
+ /// <para>For the integration tests, a small (8-document) collection is indexed. The
/// tests verify that for a specific query, all relevant documents are returned
/// in the correct order. The collection consists of two poems of English poet
- /// <a href="http://en.wikipedia.org/wiki/William_blake">William Blake</a>.</p>
- /// <p>Note: the list of Similarities is maintained by hand. If a new Similarity
- /// is added to the {@code Lucene.Net.Search.Similarities} package, the
- /// list should be updated accordingly.</p>
- /// <p>
+ /// <a href="http://en.wikipedia.org/wiki/William_blake">William Blake</a>.</para>
+ /// <para>Note: the list of Similarities is maintained by hand. If a new Similarity
+ /// is added to the <see cref="Lucene.Net.Search.Similarities"/> package, the
+ /// list should be updated accordingly.</para>
+ /// <para>
/// In the correctness tests, the score is verified against the result of manual
/// computation. Since it would be impossible to test all Similarities
/// (e.g. all possible DFR combinations, all parameter values for LM), only
/// the best performing setups in the original papers are verified.
- /// </p>
+ /// </para>
/// </summary>
[TestFixture]
public class TestSimilarityBase : LuceneTestCase
@@ -233,7 +233,7 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// Tests correct behavior when
- /// {@code numberOfDocuments = numberOfFieldTokens}.
+ /// <c>numberOfDocuments = numberOfFieldTokens</c>.
/// </summary>
[Test]
public virtual void TestSparseDocuments()
@@ -247,7 +247,7 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// Tests correct behavior when
- /// {@code numberOfDocuments > numberOfFieldTokens}.
+ /// <c>numberOfDocuments > numberOfFieldTokens</c>.
/// </summary>
[Test]
public virtual void TestVerySparseDocuments()
@@ -261,7 +261,7 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// Tests correct behavior when
- /// {@code NumberOfDocuments = 1}.
+ /// <c>NumberOfDocuments = 1</c>.
/// </summary>
[Test]
public virtual void TestOneDocument()
@@ -277,7 +277,7 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// Tests correct behavior when
- /// {@code docFreq = numberOfDocuments}.
+ /// <c>docFreq = numberOfDocuments</c>.
/// </summary>
[Test]
public virtual void TestAllDocumentsRelevant()
@@ -291,7 +291,7 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// Tests correct behavior when
- /// {@code docFreq > numberOfDocuments / 2}.
+ /// <c>docFreq > numberOfDocuments / 2</c>.
/// </summary>
[Test]
public virtual void TestMostDocumentsRelevant()
@@ -305,7 +305,7 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// Tests correct behavior when
- /// {@code docFreq = 1}.
+ /// <c>docFreq = 1</c>.
/// </summary>
[Test]
public virtual void TestOnlyOneRelevantDocument()
@@ -318,7 +318,7 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// Tests correct behavior when
- /// {@code totalTermFreq = numberOfFieldTokens}.
+ /// <c>totalTermFreq = numberOfFieldTokens</c>.
/// </summary>
[Test]
public virtual void TestAllTermsRelevant()
@@ -332,7 +332,7 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// Tests correct behavior when
- /// {@code totalTermFreq > numberOfDocuments}.
+ /// <c>totalTermFreq > numberOfDocuments</c>.
/// </summary>
[Test]
public virtual void TestMoreTermsThanDocuments()
@@ -344,7 +344,7 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// Tests correct behavior when
- /// {@code totalTermFreq = numberOfDocuments}.
+ /// <c>totalTermFreq = numberOfDocuments</c>.
/// </summary>
[Test]
public virtual void TestNumberOfTermsAsDocuments()
@@ -355,7 +355,7 @@ namespace Lucene.Net.Search.Similarities
}
/// <summary>
- /// Tests correct behavior when {@code totalTermFreq = 1}.
+ /// Tests correct behavior when <c>totalTermFreq = 1</c>.
/// </summary>
[Test]
public virtual void TestOneTerm()
@@ -367,7 +367,7 @@ namespace Lucene.Net.Search.Similarities
}
/// <summary>
- /// Tests correct behavior when {@code totalTermFreq = freq}.
+ /// Tests correct behavior when <c>totalTermFreq = freq</c>.
/// </summary>
[Test]
public virtual void TestOneRelevantDocument()
@@ -379,7 +379,7 @@ namespace Lucene.Net.Search.Similarities
}
/// <summary>
- /// Tests correct behavior when {@code numberOfFieldTokens = freq}.
+ /// Tests correct behavior when <c>numberOfFieldTokens = freq</c>.
/// </summary>
[Test]
public virtual void TestAllTermsRelevantOnlyOneDocument()
@@ -425,7 +425,7 @@ namespace Lucene.Net.Search.Similarities
}
/// <summary>
- /// Tests correct behavior when {@code avgFieldLength = docLen}.
+ /// Tests correct behavior when <c>avgFieldLength = docLen</c>.
/// </summary>
[Test]
public virtual void TestDocumentLengthAverage()
@@ -570,9 +570,9 @@ namespace Lucene.Net.Search.Similarities
/// <summary>
/// The generic test core called by all correctness test methods. It calls the
- /// <seealso cref="SimilarityBase#score(BasicStats, float, float)"/> method of all
- /// Similarities in <seealso cref="#sims"/> and compares the score against the manually
- /// computed {@code gold}.
+ /// <see cref="SimilarityBase.Score(BasicStats, float, float)"/> method of all
+ /// Similarities in <see cref="Sims"/> and compares the score against the manually
+ /// computed <c>gold</c>.
/// </summary>
private void CorrectnessTestCore(SimilarityBase sim, float gold)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net.Tests/Search/TestTimeLimitingCollector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Tests/Search/TestTimeLimitingCollector.cs b/src/Lucene.Net.Tests/Search/TestTimeLimitingCollector.cs
index dda1ac7..c2ca5dd 100644
--- a/src/Lucene.Net.Tests/Search/TestTimeLimitingCollector.cs
+++ b/src/Lucene.Net.Tests/Search/TestTimeLimitingCollector.cs
@@ -31,7 +31,7 @@ namespace Lucene.Net.Search
*/
/// <summary>
- /// Tests the {@link TimeLimitingCollector}. This test checks (1) search
+ /// Tests the <see cref="TimeLimitingCollector"/>. This test checks (1) search
/// correctness(regardless of timeout), (2) expected timeout behavior,
/// and(3) a sanity test with multiple searching threads.
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net/Codecs/CodecUtil.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/CodecUtil.cs b/src/Lucene.Net/Codecs/CodecUtil.cs
index a6dd3af..7f1f73d 100644
--- a/src/Lucene.Net/Codecs/CodecUtil.cs
+++ b/src/Lucene.Net/Codecs/CodecUtil.cs
@@ -167,7 +167,7 @@ namespace Lucene.Net.Codecs
/// CodecFooter --> Magic,AlgorithmID,Checksum
/// <list type="bullet">
/// <item><description>Magic --> Uint32 (<see cref="DataOutput.WriteInt32(int)"/>). this
- /// identifies the start of the footer. It is always {@value #FOOTER_MAGIC}.</description></item>
+ /// identifies the start of the footer. It is always <see cref="FOOTER_MAGIC"/>.</description></item>
/// <item><description>AlgorithmID --> Uint32 (<see cref="DataOutput.WriteInt32(int)"/>). this
/// indicates the checksum algorithm used. Currently this is always 0,
/// for zlib-crc32.</description></item>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net/Codecs/MultiLevelSkipListWriter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/MultiLevelSkipListWriter.cs b/src/Lucene.Net/Codecs/MultiLevelSkipListWriter.cs
index 2c5e960..d3865f0 100644
--- a/src/Lucene.Net/Codecs/MultiLevelSkipListWriter.cs
+++ b/src/Lucene.Net/Codecs/MultiLevelSkipListWriter.cs
@@ -94,7 +94,7 @@ namespace Lucene.Net.Codecs
}
/// <summary>
- /// Creates a <see cref="MultiLevelSkipListWriter"/>{@code }, where
+ /// Creates a <see cref="MultiLevelSkipListWriter"/>, where
/// <see cref="skipInterval"/> and <see cref="skipMultiplier"/> are
/// the same.
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net/Index/LogMergePolicy.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Index/LogMergePolicy.cs b/src/Lucene.Net/Index/LogMergePolicy.cs
index 35324d1..fa69f6e 100644
--- a/src/Lucene.Net/Index/LogMergePolicy.cs
+++ b/src/Lucene.Net/Index/LogMergePolicy.cs
@@ -257,10 +257,10 @@ namespace Lucene.Net.Index
/// <summary>
/// Returns the merges necessary to merge the index, taking the max merge
/// size or max merge docs into consideration. this method attempts to respect
- /// the {@code maxNumSegments} parameter, however it might be, due to size
+ /// the <paramref name="maxNumSegments"/> parameter, however it might be, due to size
/// constraints, that more than that number of segments will remain in the
- /// index. Also, this method does not guarantee that exactly {@code
- /// maxNumSegments} will remain, but <= that number.
+ /// index. Also, this method does not guarantee that exactly
+ /// <paramref name="maxNumSegments"/> will remain, but <= that number.
/// </summary>
private MergeSpecification FindForcedMergesSizeLimit(SegmentInfos infos, int maxNumSegments, int last)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net/Util/OpenBitSet.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Util/OpenBitSet.cs b/src/Lucene.Net/Util/OpenBitSet.cs
index 5d7704f..e30a849 100644
--- a/src/Lucene.Net/Util/OpenBitSet.cs
+++ b/src/Lucene.Net/Util/OpenBitSet.cs
@@ -986,19 +986,19 @@ namespace Lucene.Net.Util
// some BitSet compatability methods
- //** see {@link intersect} */
+ /// <summary>see <see cref="Intersect(OpenBitSet)"/></summary>
public virtual void And(OpenBitSet other)
{
Intersect(other);
}
- //** see {@link union} */
+ /// <summary>see <see cref="Union(OpenBitSet)"/></summary>
public virtual void Or(OpenBitSet other)
{
Union(other);
}
- //** see {@link andNot} */
+ /// <summary>see <see cref="AndNot(OpenBitSet)"/></summary>
public virtual void AndNot(OpenBitSet other)
{
Remove(other);
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/db3d0238/src/Lucene.Net/Util/QueryBuilder.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Util/QueryBuilder.cs b/src/Lucene.Net/Util/QueryBuilder.cs
index 8abe1cb..c810e01 100644
--- a/src/Lucene.Net/Util/QueryBuilder.cs
+++ b/src/Lucene.Net/Util/QueryBuilder.cs
@@ -123,7 +123,7 @@ namespace Lucene.Net.Util
/// </summary>
/// <param name="field"> Field name. </param>
/// <param name="queryText"> Text to be passed to the analyzer. </param>
- /// <param name="fraction"> of query terms {@code [0..1]} that should match </param>
+ /// <param name="fraction"> of query terms <c>[0..1]</c> that should match </param>
/// <returns> <see cref="TermQuery"/> or <see cref="BooleanQuery"/>, based on the analysis
/// of <paramref name="queryText"/>. </returns>
public virtual Query CreateMinShouldMatchQuery(string field, string queryText, float fraction)