You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by cc...@apache.org on 2011/11/06 06:24:44 UTC
[Lucene.Net] svn commit: r1198132 [12/17] - in /incubator/lucene.net/trunk/src:
contrib/Analyzers/AR/ contrib/Analyzers/BR/ contrib/Analyzers/CJK/
contrib/Analyzers/Cz/ contrib/Analyzers/De/ contrib/Analyzers/Fr/
contrib/Analyzers/Miscellaneous/ contrib/Analyzers/N...
Modified: incubator/lucene.net/trunk/src/core/Search/Function/CustomScoreQuery.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/CustomScoreQuery.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/CustomScoreQuery.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/CustomScoreQuery.cs Sun Nov 6 05:24:26 2011
@@ -31,13 +31,13 @@ namespace Lucene.Net.Search.Function
{
/// <summary> Query that sets document score as a programmatic function of several (sub) scores:
- /// <ol>
- /// <li>the score of its subQuery (any query)</li>
- /// <li>(optional) the score of its ValueSourceQuery (or queries).
+ /// <list type="bullet">
+ /// <item>the score of its subQuery (any query)</item>
+ /// <item>(optional) the score of its ValueSourceQuery (or queries).
/// For most simple/convenient use cases this query is likely to be a
- /// {@link Lucene.Net.Search.Function.FieldScoreQuery FieldScoreQuery}</li>
- /// </ol>
- /// Subclasses can modify the computation by overriding {@link #getCustomScoreProvider}.
+ /// <see cref="Lucene.Net.Search.Function.FieldScoreQuery">FieldScoreQuery</see></item>
+ /// </list>
+ /// Subclasses can modify the computation by overriding <see cref="GetCustomScoreProvider" />.
///
/// <p/><font color="#FF0000">
/// WARNING: The status of the <b>Search.Function</b> package is experimental.
@@ -59,24 +59,24 @@ namespace Lucene.Net.Search.Function
{
}
- /// <summary> Create a CustomScoreQuery over input subQuery and a {@link ValueSourceQuery}.</summary>
+ /// <summary> Create a CustomScoreQuery over input subQuery and a <see cref="ValueSourceQuery" />.</summary>
/// <param name="subQuery">the sub query whose score is being customed. Must not be null.
/// </param>
/// <param name="valSrcQuery">a value source query whose scores are used in the custom score
/// computation. For most simple/convineient use case this would be a
- /// {@link Lucene.Net.Search.Function.FieldScoreQuery FieldScoreQuery}.
+ /// <see cref="Lucene.Net.Search.Function.FieldScoreQuery">FieldScoreQuery</see>.
/// This parameter is optional - it can be null or even an empty array.
/// </param>
public CustomScoreQuery(Query subQuery, ValueSourceQuery valSrcQuery):this(subQuery, valSrcQuery != null?new ValueSourceQuery[]{valSrcQuery}:new ValueSourceQuery[0])
{
}
- /// <summary> Create a CustomScoreQuery over input subQuery and a {@link ValueSourceQuery}.</summary>
+ /// <summary> Create a CustomScoreQuery over input subQuery and a <see cref="ValueSourceQuery" />.</summary>
/// <param name="subQuery">the sub query whose score is being customized. Must not be null.
/// </param>
/// <param name="valSrcQueries">value source queries whose scores are used in the custom score
/// computation. For most simple/convenient use case these would be
- /// {@link Lucene.Net.Search.Function.FieldScoreQuery FieldScoreQueries}.
+ /// <see cref="Lucene.Net.Search.Function.FieldScoreQuery">FieldScoreQueries</see>.
/// This parameter is optional - it can be null or even an empty array.
/// </param>
public CustomScoreQuery(Query subQuery, ValueSourceQuery[] valSrcQueries)
@@ -87,7 +87,7 @@ namespace Lucene.Net.Search.Function
throw new System.ArgumentException("<subquery> must not be null!");
}
- /*(non-Javadoc) @see Lucene.Net.Search.Query#rewrite(Lucene.Net.Index.IndexReader) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Query.rewrite(Lucene.Net.Index.IndexReader) */
public override Query Rewrite(IndexReader reader)
{
CustomScoreQuery clone = null;
@@ -112,7 +112,7 @@ namespace Lucene.Net.Search.Function
return (clone == null) ? this : clone;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Query#extractTerms(java.util.Set) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Query.extractTerms(java.util.Set) */
public override void ExtractTerms(System.Collections.Hashtable terms)
{
subQuery.ExtractTerms(terms);
@@ -122,7 +122,7 @@ namespace Lucene.Net.Search.Function
}
}
- /*(non-Javadoc) @see Lucene.Net.Search.Query#clone() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Query.clone() */
public override System.Object Clone()
{
CustomScoreQuery clone = (CustomScoreQuery) base.Clone();
@@ -135,7 +135,7 @@ namespace Lucene.Net.Search.Function
return clone;
}
- /* (non-Javadoc) @see Lucene.Net.Search.Query#toString(java.lang.String) */
+ /* (non-Javadoc) <see cref="Lucene.Net.Search.Query.toString(java.lang.String) */
public override System.String ToString(System.String field)
{
System.Text.StringBuilder sb = new System.Text.StringBuilder(Name()).Append("(");
@@ -149,7 +149,7 @@ namespace Lucene.Net.Search.Function
return sb.ToString() + ToStringUtils.Boost(GetBoost());
}
- /// <summary>Returns true if <code>o</code> is equal to this. </summary>
+ /// <summary>Returns true if <c>o</c> is equal to this. </summary>
public override bool Equals(System.Object o)
{
if (GetType() != o.GetType())
@@ -189,12 +189,11 @@ namespace Lucene.Net.Search.Function
}
- /**
- * Returns a {@link CustomScoreProvider} that calculates the custom scores
- * for the given {@link IndexReader}. The default implementation returns a default
- * implementation as specified in the docs of {@link CustomScoreProvider}.
- * @since 2.9.2
- */
+ /// <summary>
+ /// Returns a <see cref="CustomScoreProvider" /> that calculates the custom scores
+ /// for the given <see cref="IndexReader" />. The default implementation returns a default
+ /// implementation as specified in the docs of <see cref="CustomScoreProvider" />.
+ /// </summary>
protected virtual CustomScoreProvider GetCustomScoreProvider(IndexReader reader)
{
// when deprecated methods are removed, do not extend class here, just return new default CustomScoreProvider
@@ -235,8 +234,8 @@ namespace Lucene.Net.Search.Function
///
/// The doc is relative to the current reader, which is
/// unknown to CustomScoreQuery when using per-segment search (since Lucene 2.9).
- /// Please override {@link #getCustomScoreProvider} and return a subclass
- /// of {@link CustomScoreProvider} for the given {@link IndexReader}.
+ /// Please override <see cref="GetCustomScoreProvider" /> and return a subclass
+ /// of <see cref="CustomScoreProvider" /> for the given <see cref="IndexReader" />.
/// see CustomScoreProvider#customScore(int,float,float[])
/// </summary>
[Obsolete("Will be removed in Lucene 3.1")]
@@ -262,10 +261,10 @@ namespace Lucene.Net.Search.Function
///
/// The doc is relative to the current reader, which is
/// unknown to CustomScoreQuery when using per-segment search (since Lucene 2.9).
- /// Please override {@link #getCustomScoreProvider} and return a subclass
- /// of {@link CustomScoreProvider} for the given {@link IndexReader}.
- /// @see CustomScoreProvider#customScore(int,float,float)
- /// </summary>
+ /// Please override <see cref="GetCustomScoreProvider" /> and return a subclass
+ /// of <see cref="CustomScoreProvider" /> for the given <see cref="IndexReader" />.
+ /// </summary>
+ /// <seealso cref="CustomScoreProvider.CustomScore(int,float,float)" />
[Obsolete("Will be removed in Lucene 3.1")]
public virtual float CustomScore(int doc, float subQueryScore, float valSrcScore)
{
@@ -278,8 +277,8 @@ namespace Lucene.Net.Search.Function
///
/// The doc is relative to the current reader, which is
/// unknown to CustomScoreQuery when using per-segment search (since Lucene 2.9).
- /// Please override {@link #getCustomScoreProvider} and return a subclass
- /// of {@link CustomScoreProvider} for the given {@link IndexReader}.
+ /// Please override <see cref="GetCustomScoreProvider(IndexReader)" /> and return a subclass
+ /// of <see cref="CustomScoreProvider" /> for the given <see cref="IndexReader" />.
/// </summary>
[Obsolete("Will be removed in Lucene 3.1.")]
public virtual Explanation CustomExplain(int doc, Explanation subQueryExpl, Explanation[] valSrcExpls)
@@ -309,8 +308,8 @@ namespace Lucene.Net.Search.Function
/// <summary> Explain the custom score.
/// The doc is relative to the current reader, which is
/// unknown to CustomScoreQuery when using per-segment search (since Lucene 2.9).
- /// Please override {@link #getCustomScoreProvider} and return a subclass
- /// of {@link CustomScoreProvider} for the given {@link IndexReader}.
+ /// Please override <see cref="GetCustomScoreProvider" /> and return a subclass
+ /// of <see cref="CustomScoreProvider" /> for the given <see cref="IndexReader" />.
/// </summary>
[Obsolete("Will be removed in Lucene 3.1")]
public virtual Explanation CustomExplain(int doc, Explanation subQueryExpl, Explanation valSrcExpl)
@@ -362,19 +361,19 @@ namespace Lucene.Net.Search.Function
this.qStrict = Enclosing_Instance.strict;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Weight#getQuery() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Weight.getQuery() */
public override Query GetQuery()
{
return Enclosing_Instance;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Weight#getValue() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Weight.getValue() */
public override float GetValue()
{
return Enclosing_Instance.GetBoost();
}
- /*(non-Javadoc) @see Lucene.Net.Search.Weight#sumOfSquaredWeights() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Weight.sumOfSquaredWeights() */
public override float SumOfSquaredWeights()
{
float sum = subQueryWeight.SumOfSquaredWeights();
@@ -393,7 +392,7 @@ namespace Lucene.Net.Search.Function
return sum;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Weight#normalize(float) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Weight.normalize(float) */
public override void Normalize(float norm)
{
norm *= Enclosing_Instance.GetBoost(); // incorporate boost
@@ -509,7 +508,7 @@ namespace Lucene.Net.Search.Function
this.provider = this.Enclosing_Instance.GetCustomScoreProvider(reader);
}
- /// <deprecated> use {@link #NextDoc()} instead.
+ /// <deprecated> use <see cref="NextDoc()" /> instead.
/// </deprecated>
[Obsolete("use NextDoc() instead.")]
public override bool Next()
@@ -530,7 +529,7 @@ namespace Lucene.Net.Search.Function
return doc;
}
- /// <deprecated> use {@link #DocID()} instead.
+ /// <deprecated> use <see cref="DocID()" /> instead.
/// </deprecated>
[Obsolete("use DocID() instead.")]
public override int Doc()
@@ -543,7 +542,7 @@ namespace Lucene.Net.Search.Function
return subQueryScorer.DocID();
}
- /*(non-Javadoc) @see Lucene.Net.Search.Scorer#score() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Scorer.score() */
public override float Score()
{
for (int i = 0; i < valSrcScorers.Length; i++)
@@ -553,7 +552,7 @@ namespace Lucene.Net.Search.Function
return qWeight * provider.CustomScore(subQueryScorer.DocID(), subQueryScorer.Score(), vScores);
}
- /// <deprecated> use {@link #Advance(int)} instead.
+ /// <deprecated> use <see cref="Advance(int)" /> instead.
/// </deprecated>
[Obsolete("use Advance(int) instead.")]
public override bool SkipTo(int target)
@@ -575,7 +574,7 @@ namespace Lucene.Net.Search.Function
}
// TODO: remove in 3.0
- /*(non-Javadoc) @see Lucene.Net.Search.Scorer#explain(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Scorer.explain(int) */
public override Explanation Explain(int doc)
{
Explanation subQueryExpl = weight.subQueryWeight.Explain(reader, doc);
@@ -626,7 +625,7 @@ namespace Lucene.Net.Search.Function
this.strict = strict;
}
- /// <summary> A short name of this query, used in {@link #ToString(String)}.</summary>
+ /// <summary> A short name of this query, used in <see cref="ToString(String)" />.</summary>
public virtual System.String Name()
{
return "custom";
Modified: incubator/lucene.net/trunk/src/core/Search/Function/DocValues.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/DocValues.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/DocValues.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/DocValues.cs Sun Nov 6 05:24:26 2011
@@ -24,7 +24,7 @@ namespace Lucene.Net.Search.Function
/// <summary> Expert: represents field values as different types.
/// Normally created via a
- /// {@link Lucene.Net.Search.Function.ValueSource ValueSuorce}
+ /// <see cref="Lucene.Net.Search.Function.ValueSource">ValueSuorce</see>
/// for a particular field and reader.
///
/// <p/><font color="#FF0000">
@@ -104,10 +104,10 @@ namespace Lucene.Net.Search.Function
/// <summary> Expert: for test purposes only, return the inner array of values, or null if not applicable.
/// <p/>
/// Allows tests to verify that loaded values are:
- /// <ol>
- /// <li>indeed cached/reused.</li>
- /// <li>stored in the expected size/type (byte/short/int/float).</li>
- /// </ol>
+ /// <list type="bullet">
+ /// <item>indeed cached/reused.</item>
+ /// <item>stored in the expected size/type (byte/short/int/float).</item>
+ /// </list>
/// Note: implementations of DocValues must override this method for
/// these test elements to be tested, Otherwise the test would not fail, just
/// print a warning.
@@ -152,14 +152,14 @@ namespace Lucene.Net.Search.Function
computed = true;
}
- /// <summary> Returns the minimum of all values or <code>Float.NaN</code> if this
+ /// <summary> Returns the minimum of all values or <c>Float.NaN</c> if this
/// DocValues instance does not contain any value.
/// <p/>
/// This operation is optional
/// <p/>
///
/// </summary>
- /// <returns> the minimum of all values or <code>Float.NaN</code> if this
+ /// <returns> the minimum of all values or <c>Float.NaN</c> if this
/// DocValues instance does not contain any value.
/// </returns>
public virtual float GetMinValue()
@@ -168,14 +168,14 @@ namespace Lucene.Net.Search.Function
return minVal;
}
- /// <summary> Returns the maximum of all values or <code>Float.NaN</code> if this
+ /// <summary> Returns the maximum of all values or <c>Float.NaN</c> if this
/// DocValues instance does not contain any value.
/// <p/>
/// This operation is optional
/// <p/>
///
/// </summary>
- /// <returns> the maximum of all values or <code>Float.NaN</code> if this
+ /// <returns> the maximum of all values or <c>Float.NaN</c> if this
/// DocValues instance does not contain any value.
/// </returns>
public virtual float GetMaxValue()
@@ -184,14 +184,14 @@ namespace Lucene.Net.Search.Function
return maxVal;
}
- /// <summary> Returns the average of all values or <code>Float.NaN</code> if this
+ /// <summary> Returns the average of all values or <c>Float.NaN</c> if this
/// DocValues instance does not contain any value. *
/// <p/>
/// This operation is optional
/// <p/>
///
/// </summary>
- /// <returns> the average of all values or <code>Float.NaN</code> if this
+ /// <returns> the average of all values or <c>Float.NaN</c> if this
/// DocValues instance does not contain any value
/// </returns>
public virtual float GetAverageValue()
Modified: incubator/lucene.net/trunk/src/core/Search/Function/FieldCacheSource.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/FieldCacheSource.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/FieldCacheSource.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/FieldCacheSource.cs Sun Nov 6 05:24:26 2011
@@ -24,7 +24,7 @@ namespace Lucene.Net.Search.Function
{
/// <summary> Expert: A base class for ValueSource implementations that retrieve values for
- /// a single field from the {@link Lucene.Net.Search.FieldCache FieldCache}.
+ /// a single field from the <see cref="Lucene.Net.Search.FieldCache">FieldCache</see>.
/// <p/>
/// Fields used herein nust be indexed (doesn't matter if these fields are stored or not).
/// <p/>
@@ -32,7 +32,7 @@ namespace Lucene.Net.Search.Function
/// For documents with multiple tokens of the same field, behavior is undefined (It is likely that current
/// code would use the value of one of these tokens, but this is not guaranteed).
/// <p/>
- /// Document with no tokens in this field are assigned the <code>Zero</code> value.
+ /// Document with no tokens in this field are assigned the <c>Zero</c> value.
///
/// <p/><font color="#FF0000">
/// WARNING: The status of the <b>Search.Function</b> package is experimental.
@@ -40,13 +40,13 @@ namespace Lucene.Net.Search.Function
/// supported anymore in such a case.</font>
///
/// <p/><b>NOTE</b>: with the switch in 2.9 to segment-based
- /// searching, if {@link #getValues} is invoked with a
+ /// searching, if <see cref="GetValues" /> is invoked with a
/// composite (multi-segment) reader, this can easily cause
/// double RAM usage for the values in the FieldCache. It's
/// best to switch your application to pass only atomic
/// (single segment) readers to this API. Alternatively, for
/// a short-term fix, you could wrap your ValueSource using
- /// {@link MultiValueSource}, which costs more CPU per lookup
+ /// <see cref="MultiValueSource" />, which costs more CPU per lookup
/// but will not consume double the FieldCache RAM.<p/>
/// </summary>
[Serializable]
@@ -60,13 +60,13 @@ namespace Lucene.Net.Search.Function
this.field = field;
}
- /* (non-Javadoc) @see Lucene.Net.Search.Function.ValueSource#getValues(Lucene.Net.Index.IndexReader) */
+ /* (non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.getValues(Lucene.Net.Index.IndexReader) */
public override DocValues GetValues(IndexReader reader)
{
return GetCachedFieldValues(Lucene.Net.Search.FieldCache_Fields.DEFAULT, field, reader);
}
- /* (non-Javadoc) @see Lucene.Net.Search.Function.ValueSource#description() */
+ /* (non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.description() */
public override System.String Description()
{
return field;
@@ -81,7 +81,7 @@ namespace Lucene.Net.Search.Function
/// </seealso>
public abstract DocValues GetCachedFieldValues(FieldCache cache, System.String field, IndexReader reader);
- /*(non-Javadoc) @see java.lang.Object#equals(java.lang.Object) */
+ /*(non-Javadoc) <see cref="java.lang.Object.equals(java.lang.Object) */
public override bool Equals(System.Object o)
{
if (!(o is FieldCacheSource))
@@ -92,21 +92,21 @@ namespace Lucene.Net.Search.Function
return this.field.Equals(other.field) && CachedFieldSourceEquals(other);
}
- /*(non-Javadoc) @see java.lang.Object#hashCode() */
+ /*(non-Javadoc) <see cref="java.lang.Object.hashCode() */
public override int GetHashCode()
{
return field.GetHashCode() + CachedFieldSourceHashCode();
}
- /// <summary> Check if equals to another {@link FieldCacheSource}, already knowing that cache and field are equal. </summary>
- /// <seealso cref="Object.equals(java.lang.Object)">
+ /// <summary> Check if equals to another <see cref="FieldCacheSource" />, already knowing that cache and field are equal. </summary>
+ /// <seealso cref="Object.Equals(Object)">
/// </seealso>
public abstract bool CachedFieldSourceEquals(FieldCacheSource other);
- /// <summary> Return a hash code of a {@link FieldCacheSource}, without the hash-codes of the field
+ /// <summary> Return a hash code of a <see cref="FieldCacheSource" />, without the hash-codes of the field
/// and the cache (those are taken care of elsewhere).
/// </summary>
- /// <seealso cref="Object.hashCode()">
+ /// <seealso cref="Object.GetHashCode()">
/// </seealso>
public abstract int CachedFieldSourceHashCode();
}
Modified: incubator/lucene.net/trunk/src/core/Search/Function/FieldScoreQuery.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/FieldScoreQuery.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/FieldScoreQuery.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/FieldScoreQuery.cs Sun Nov 6 05:24:26 2011
@@ -26,12 +26,12 @@ namespace Lucene.Net.Search.Function
/// value of that field.
/// <p/>
/// It is assumed, and expected, that:
- /// <ul>
- /// <li>The field used here is indexed, and has exactly
- /// one token in every scored document.</li>
- /// <li>Best if this field is un_tokenized.</li>
- /// <li>That token is parsable to the selected type.</li>
- /// </ul>
+ /// <list type="bullet">
+ /// <item>The field used here is indexed, and has exactly
+ /// one token in every scored document.</item>
+ /// <item>Best if this field is un_tokenized.</item>
+ /// <item>That token is parsable to the selected type.</item>
+ /// </list>
/// <p/>
/// Combining this query in a FunctionQuery allows much freedom in affecting document scores.
/// Note, that with this freedom comes responsibility: it is more than likely that the
@@ -41,12 +41,12 @@ namespace Lucene.Net.Search.Function
/// When contructing this query, select the appropriate type. That type should match the data stored in the
/// field. So in fact the "right" type should be selected before indexing. Type selection
/// has effect on the RAM usage:
- /// <ul>
- /// <li>{@link Type#BYTE} consumes 1 * maxDocs bytes.</li>
- /// <li>{@link Type#SHORT} consumes 2 * maxDocs bytes.</li>
- /// <li>{@link Type#INT} consumes 4 * maxDocs bytes.</li>
- /// <li>{@link Type#FLOAT} consumes 8 * maxDocs bytes.</li>
- /// </ul>
+ /// <list type="bullet">
+ /// <item><see cref="Type.BYTE" /> consumes 1 * maxDocs bytes.</item>
+ /// <item><see cref="Type.SHORT" /> consumes 2 * maxDocs bytes.</item>
+ /// <item><see cref="Type.INT" /> consumes 4 * maxDocs bytes.</item>
+ /// <item><see cref="Type.FLOAT" /> consumes 8 * maxDocs bytes.</item>
+ /// </list>
/// <p/>
/// <b>Caching:</b>
/// Values for the numeric field are loaded once and cached in memory for further use with the same IndexReader.
@@ -67,12 +67,12 @@ namespace Lucene.Net.Search.Function
/// <p/>
/// The type selected at search search time should match the data stored in the field.
/// Different types have different RAM requirements:
- /// <ul>
- /// <li>{@link #BYTE} consumes 1 * maxDocs bytes.</li>
- /// <li>{@link #SHORT} consumes 2 * maxDocs bytes.</li>
- /// <li>{@link #INT} consumes 4 * maxDocs bytes.</li>
- /// <li>{@link #FLOAT} consumes 8 * maxDocs bytes.</li>
- /// </ul>
+ /// <list type="bullet">
+ /// <item><see cref="BYTE" /> consumes 1 * maxDocs bytes.</item>
+ /// <item><see cref="SHORT" /> consumes 2 * maxDocs bytes.</item>
+ /// <item><see cref="INT" /> consumes 4 * maxDocs bytes.</item>
+ /// <item><see cref="FLOAT" /> consumes 8 * maxDocs bytes.</item>
+ /// </list>
/// </summary>
public class Type
{
@@ -94,7 +94,7 @@ namespace Lucene.Net.Search.Function
{
this.typeName = name;
}
- /*(non-Javadoc) @see java.lang.Object#toString() */
+ /*(non-Javadoc) <see cref="java.lang.Object.toString() */
public override System.String ToString()
{
return GetType().FullName + "::" + typeName;
@@ -103,12 +103,12 @@ namespace Lucene.Net.Search.Function
/// <summary> Create a FieldScoreQuery - a query that scores each document as the value of the numeric input field.
/// <p/>
- /// The <code>type</code> param tells how to parse the field string values into a numeric score value.
+ /// The <c>type</c> param tells how to parse the field string values into a numeric score value.
/// </summary>
/// <param name="field">the numeric field to be used.
/// </param>
/// <param name="type">the type of the field: either
- /// {@link Type#BYTE}, {@link Type#SHORT}, {@link Type#INT}, or {@link Type#FLOAT}.
+ /// <see cref="Type.BYTE" />, <see cref="Type.SHORT" />, <see cref="Type.INT" />, or <see cref="Type.FLOAT" />.
/// </param>
public FieldScoreQuery(System.String field, Type type):base(GetValueSource(field, type))
{
Modified: incubator/lucene.net/trunk/src/core/Search/Function/FloatFieldSource.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/FloatFieldSource.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/FloatFieldSource.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/FloatFieldSource.cs Sun Nov 6 05:24:26 2011
@@ -24,8 +24,8 @@ namespace Lucene.Net.Search.Function
{
/// <summary> Expert: obtains float field values from the
- /// {@link Lucene.Net.Search.FieldCache FieldCache}
- /// using <code>getFloats()</code> and makes those values
+ /// <see cref="Lucene.Net.Search.FieldCache">FieldCache</see>
+ /// using <c>getFloats()</c> and makes those values
/// available as other numeric types, casting as needed.
///
/// <p/><font color="#FF0000">
@@ -38,13 +38,13 @@ namespace Lucene.Net.Search.Function
/// on the field.
///
/// <p/><b>NOTE</b>: with the switch in 2.9 to segment-based
- /// searching, if {@link #getValues} is invoked with a
+ /// searching, if <see cref="FieldCacheSource.GetValues" /> is invoked with a
/// composite (multi-segment) reader, this can easily cause
/// double RAM usage for the values in the FieldCache. It's
/// best to switch your application to pass only atomic
/// (single segment) readers to this API. Alternatively, for
/// a short-term fix, you could wrap your ValueSource using
- /// {@link MultiValueSource}, which costs more CPU per lookup
+ /// <see cref="MultiValueSource" />, which costs more CPU per lookup
/// but will not consume double the FieldCache RAM.<p/>
/// </seealso>
[Serializable]
@@ -71,17 +71,17 @@ namespace Lucene.Net.Search.Function
}
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#floatVal(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.floatVal(int) */
public override float FloatVal(int doc)
{
return arr[doc];
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#toString(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.toString(int) */
public override System.String ToString(int doc)
{
return Enclosing_Instance.Description() + '=' + arr[doc];
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#getInnerArray() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.getInnerArray() */
public /*internal*/ override System.Object GetInnerArray()
{
return arr;
@@ -100,20 +100,20 @@ namespace Lucene.Net.Search.Function
this.parser = parser;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.ValueSource#description() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.description() */
public override System.String Description()
{
return "float(" + base.Description() + ')';
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.FieldCacheSource#getCachedValues(Lucene.Net.Search.FieldCache, java.lang.String, Lucene.Net.Index.IndexReader) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.FieldCacheSource.getCachedValues(Lucene.Net.Search.FieldCache, java.lang.String, Lucene.Net.Index.IndexReader) */
public override DocValues GetCachedFieldValues(FieldCache cache, System.String field, IndexReader reader)
{
float[] arr = cache.GetFloats(reader, field, parser);
return new AnonymousClassDocValues(arr, this);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.FieldCacheSource#cachedFieldSourceEquals(Lucene.Net.Search.Function.FieldCacheSource) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.FieldCacheSource.cachedFieldSourceEquals(Lucene.Net.Search.Function.FieldCacheSource) */
public override bool CachedFieldSourceEquals(FieldCacheSource o)
{
if (o.GetType() != typeof(FloatFieldSource))
@@ -124,7 +124,7 @@ namespace Lucene.Net.Search.Function
return this.parser == null?other.parser == null:this.parser.GetType() == other.parser.GetType();
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.FieldCacheSource#cachedFieldSourceHashCode() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.FieldCacheSource.cachedFieldSourceHashCode() */
public override int CachedFieldSourceHashCode()
{
return parser == null?typeof(System.Single).GetHashCode():parser.GetType().GetHashCode();
Modified: incubator/lucene.net/trunk/src/core/Search/Function/IntFieldSource.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/IntFieldSource.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/IntFieldSource.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/IntFieldSource.cs Sun Nov 6 05:24:26 2011
@@ -24,8 +24,8 @@ namespace Lucene.Net.Search.Function
{
/// <summary> Expert: obtains int field values from the
- /// {@link Lucene.Net.Search.FieldCache FieldCache}
- /// using <code>getInts()</code> and makes those values
+ /// <see cref="Lucene.Net.Search.FieldCache">FieldCache</see>
+ /// using <c>getInts()</c> and makes those values
/// available as other numeric types, casting as needed.
///
/// <p/><font color="#FF0000">
@@ -38,13 +38,13 @@ namespace Lucene.Net.Search.Function
/// on the field.
///
/// <p/><b>NOTE</b>: with the switch in 2.9 to segment-based
- /// searching, if {@link #getValues} is invoked with a
+ /// searching, if <see cref="FieldCacheSource.GetValues" /> is invoked with a
/// composite (multi-segment) reader, this can easily cause
/// double RAM usage for the values in the FieldCache. It's
/// best to switch your application to pass only atomic
/// (single segment) readers to this API. Alternatively, for
/// a short-term fix, you could wrap your ValueSource using
- /// {@link MultiValueSource}, which costs more CPU per lookup
+ /// <see cref="MultiValueSource" />, which costs more CPU per lookup
/// but will not consume double the FieldCache RAM.<p/>
/// </seealso>
[Serializable]
@@ -71,22 +71,22 @@ namespace Lucene.Net.Search.Function
}
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#floatVal(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.floatVal(int) */
public override float FloatVal(int doc)
{
return (float) arr[doc];
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#intVal(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.intVal(int) */
public override int IntVal(int doc)
{
return arr[doc];
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#toString(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.toString(int) */
public override System.String ToString(int doc)
{
return Enclosing_Instance.Description() + '=' + IntVal(doc);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#getInnerArray() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.getInnerArray() */
public /*internal*/ override System.Object GetInnerArray()
{
return arr;
@@ -105,20 +105,20 @@ namespace Lucene.Net.Search.Function
this.parser = parser;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.ValueSource#description() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.description() */
public override System.String Description()
{
return "int(" + base.Description() + ')';
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.FieldCacheSource#getCachedValues(Lucene.Net.Search.FieldCache, java.lang.String, Lucene.Net.Index.IndexReader) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.FieldCacheSource.getCachedValues(Lucene.Net.Search.FieldCache, java.lang.String, Lucene.Net.Index.IndexReader) */
public override DocValues GetCachedFieldValues(FieldCache cache, System.String field, IndexReader reader)
{
int[] arr = cache.GetInts(reader, field, parser);
return new AnonymousClassDocValues(arr, this);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.FieldCacheSource#cachedFieldSourceEquals(Lucene.Net.Search.Function.FieldCacheSource) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.FieldCacheSource.cachedFieldSourceEquals(Lucene.Net.Search.Function.FieldCacheSource) */
public override bool CachedFieldSourceEquals(FieldCacheSource o)
{
if (o.GetType() != typeof(IntFieldSource))
@@ -129,7 +129,7 @@ namespace Lucene.Net.Search.Function
return this.parser == null?other.parser == null:this.parser.GetType() == other.parser.GetType();
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.FieldCacheSource#cachedFieldSourceHashCode() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.FieldCacheSource.cachedFieldSourceHashCode() */
public override int CachedFieldSourceHashCode()
{
return parser == null?typeof(System.Int32).GetHashCode():parser.GetType().GetHashCode();
Modified: incubator/lucene.net/trunk/src/core/Search/Function/MultiValueSource.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/MultiValueSource.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/MultiValueSource.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/MultiValueSource.cs Sun Nov 6 05:24:26 2011
@@ -26,7 +26,7 @@ namespace Lucene.Net.Search.Function
/// <summary>This class wraps another ValueSource, but protects
/// against accidental double RAM usage in FieldCache when
- /// a composite reader is passed to {@link #getValues}.
+ /// a composite reader is passed to <see cref="GetValues" />.
///
/// <p/><b>NOTE</b>: this class adds a CPU penalty to every
/// lookup, as it must resolve the incoming document to the
Modified: incubator/lucene.net/trunk/src/core/Search/Function/OrdFieldSource.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/OrdFieldSource.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/OrdFieldSource.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/OrdFieldSource.cs Sun Nov 6 05:24:26 2011
@@ -24,7 +24,7 @@ namespace Lucene.Net.Search.Function
{
/// <summary> Expert: obtains the ordinal of the field value from the default Lucene
- /// {@link Lucene.Net.Search.FieldCache Fieldcache} using getStringIndex().
+ /// <see cref="Lucene.Net.Search.FieldCache">Fieldcache</see> using getStringIndex().
/// <p/>
/// The native lucene index order is used to assign an ordinal value for each field value.
/// <p/>
@@ -45,13 +45,13 @@ namespace Lucene.Net.Search.Function
/// supported anymore in such a case.</font>
///
/// <p/><b>NOTE</b>: with the switch in 2.9 to segment-based
- /// searching, if {@link #getValues} is invoked with a
+ /// searching, if <see cref="GetValues" /> is invoked with a
/// composite (multi-segment) reader, this can easily cause
/// double RAM usage for the values in the FieldCache. It's
/// best to switch your application to pass only atomic
/// (single segment) readers to this API. Alternatively, for
/// a short-term fix, you could wrap your ValueSource using
- /// {@link MultiValueSource}, which costs more CPU per lookup
+ /// <see cref="MultiValueSource" />, which costs more CPU per lookup
/// but will not consume double the FieldCache RAM.<p/>
/// </summary>
@@ -79,23 +79,23 @@ namespace Lucene.Net.Search.Function
}
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#floatVal(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.floatVal(int) */
public override float FloatVal(int doc)
{
return (float) arr[doc];
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#strVal(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.strVal(int) */
public override System.String StrVal(int doc)
{
// the string value of the ordinal, not the string itself
return System.Convert.ToString(arr[doc]);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#toString(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.toString(int) */
public override System.String ToString(int doc)
{
return Enclosing_Instance.Description() + '=' + IntVal(doc);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#getInnerArray() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.getInnerArray() */
public /*internal*/ override System.Object GetInnerArray()
{
return arr;
@@ -111,20 +111,20 @@ namespace Lucene.Net.Search.Function
this.field = field;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.ValueSource#description() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.description() */
public override System.String Description()
{
return "ord(" + field + ')';
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.ValueSource#getValues(Lucene.Net.Index.IndexReader) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.getValues(Lucene.Net.Index.IndexReader) */
public override DocValues GetValues(IndexReader reader)
{
int[] arr = Lucene.Net.Search.FieldCache_Fields.DEFAULT.GetStringIndex(reader, field).order;
return new AnonymousClassDocValues(arr, this);
}
- /*(non-Javadoc) @see java.lang.Object#equals(java.lang.Object) */
+ /*(non-Javadoc) <see cref="java.lang.Object.equals(java.lang.Object) */
public override bool Equals(System.Object o)
{
if (o.GetType() != typeof(OrdFieldSource))
@@ -135,7 +135,7 @@ namespace Lucene.Net.Search.Function
private static readonly int hcode;
- /*(non-Javadoc) @see java.lang.Object#hashCode() */
+ /*(non-Javadoc) <see cref="java.lang.Object.hashCode() */
public override int GetHashCode()
{
return hcode + field.GetHashCode();
Modified: incubator/lucene.net/trunk/src/core/Search/Function/ReverseOrdFieldSource.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/ReverseOrdFieldSource.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/ReverseOrdFieldSource.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/ReverseOrdFieldSource.cs Sun Nov 6 05:24:26 2011
@@ -24,7 +24,7 @@ namespace Lucene.Net.Search.Function
{
/// <summary> Expert: obtains the ordinal of the field value from the default Lucene
- /// {@link Lucene.Net.Search.FieldCache FieldCache} using getStringIndex()
+ /// <see cref="Lucene.Net.Search.FieldCache">FieldCache</see> using getStringIndex()
/// and reverses the order.
/// <p/>
/// The native lucene index order is used to assign an ordinal value for each field value.
@@ -46,13 +46,13 @@ namespace Lucene.Net.Search.Function
/// supported anymore in such a case.</font>
///
/// <p/><b>NOTE</b>: with the switch in 2.9 to segment-based
- /// searching, if {@link #getValues} is invoked with a
+ /// searching, if <see cref="GetValues" /> is invoked with a
/// composite (multi-segment) reader, this can easily cause
/// double RAM usage for the values in the FieldCache. It's
/// best to switch your application to pass only atomic
/// (single segment) readers to this API. Alternatively, for
/// a short-term fix, you could wrap your ValueSource using
- /// {@link MultiValueSource}, which costs more CPU per lookup
+ /// <see cref="MultiValueSource" />, which costs more CPU per lookup
/// but will not consume double the FieldCache RAM.<p/>
/// </summary>
@@ -82,28 +82,28 @@ namespace Lucene.Net.Search.Function
}
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#floatVal(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.floatVal(int) */
public override float FloatVal(int doc)
{
return (float) (end - arr[doc]);
}
- /* (non-Javadoc) @see Lucene.Net.Search.Function.DocValues#intVal(int) */
+ /* (non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.intVal(int) */
public override int IntVal(int doc)
{
return end - arr[doc];
}
- /* (non-Javadoc) @see Lucene.Net.Search.Function.DocValues#strVal(int) */
+ /* (non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.strVal(int) */
public override System.String StrVal(int doc)
{
// the string value of the ordinal, not the string itself
return System.Convert.ToString(IntVal(doc));
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#toString(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.toString(int) */
public override System.String ToString(int doc)
{
return Enclosing_Instance.Description() + '=' + StrVal(doc);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#getInnerArray() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.getInnerArray() */
public /*internal*/ override System.Object GetInnerArray()
{
return arr;
@@ -119,13 +119,13 @@ namespace Lucene.Net.Search.Function
this.field = field;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.ValueSource#description() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.description() */
public override System.String Description()
{
return "rord(" + field + ')';
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.ValueSource#getValues(Lucene.Net.Index.IndexReader) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.getValues(Lucene.Net.Index.IndexReader) */
public override DocValues GetValues(IndexReader reader)
{
Lucene.Net.Search.StringIndex sindex = Lucene.Net.Search.FieldCache_Fields.DEFAULT.GetStringIndex(reader, field);
@@ -136,7 +136,7 @@ namespace Lucene.Net.Search.Function
return new AnonymousClassDocValues(end, arr, this);
}
- /*(non-Javadoc) @see java.lang.Object#equals(java.lang.Object) */
+ /*(non-Javadoc) <see cref="java.lang.Object.equals(java.lang.Object) */
public override bool Equals(System.Object o)
{
if (o.GetType() != typeof(ReverseOrdFieldSource))
@@ -147,7 +147,7 @@ namespace Lucene.Net.Search.Function
private static readonly int hcode;
- /*(non-Javadoc) @see java.lang.Object#hashCode() */
+ /*(non-Javadoc) <see cref="java.lang.Object.hashCode() */
public override int GetHashCode()
{
return hcode + field.GetHashCode();
Modified: incubator/lucene.net/trunk/src/core/Search/Function/ShortFieldSource.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/ShortFieldSource.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/ShortFieldSource.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/ShortFieldSource.cs Sun Nov 6 05:24:26 2011
@@ -24,8 +24,8 @@ namespace Lucene.Net.Search.Function
{
/// <summary> Expert: obtains short field values from the
- /// {@link Lucene.Net.Search.FieldCache FieldCache}
- /// using <code>getShorts()</code> and makes those values
+ /// <see cref="Lucene.Net.Search.FieldCache">FieldCache</see>
+ /// using <c>getShorts()</c> and makes those values
/// available as other numeric types, casting as needed.
///
/// <p/><font color="#FF0000">
@@ -38,13 +38,13 @@ namespace Lucene.Net.Search.Function
/// on the field.
///
/// <p/><b>NOTE</b>: with the switch in 2.9 to segment-based
- /// searching, if {@link #getValues} is invoked with a
+ /// searching, if <see cref="FieldCacheSource.GetValues" /> is invoked with a
/// composite (multi-segment) reader, this can easily cause
/// double RAM usage for the values in the FieldCache. It's
/// best to switch your application to pass only atomic
/// (single segment) readers to this API. Alternatively, for
/// a short-term fix, you could wrap your ValueSource using
- /// {@link MultiValueSource}, which costs more CPU per lookup
+ /// <see cref="MultiValueSource" />, which costs more CPU per lookup
/// but will not consume double the FieldCache RAM.<p/>
/// </seealso>
[Serializable]
@@ -71,22 +71,22 @@ namespace Lucene.Net.Search.Function
}
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#floatVal(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.floatVal(int) */
public override float FloatVal(int doc)
{
return (float) arr[doc];
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#intVal(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.intVal(int) */
public override int IntVal(int doc)
{
return arr[doc];
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#toString(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.toString(int) */
public override System.String ToString(int doc)
{
return Enclosing_Instance.Description() + '=' + IntVal(doc);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.DocValues#getInnerArray() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.DocValues.getInnerArray() */
public /*internal*/ override System.Object GetInnerArray()
{
return arr;
@@ -105,20 +105,20 @@ namespace Lucene.Net.Search.Function
this.parser = parser;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.ValueSource#description() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.ValueSource.description() */
public override System.String Description()
{
return "short(" + base.Description() + ')';
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.FieldCacheSource#getCachedValues(Lucene.Net.Search.FieldCache, java.lang.String, Lucene.Net.Index.IndexReader) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.FieldCacheSource.getCachedValues(Lucene.Net.Search.FieldCache, java.lang.String, Lucene.Net.Index.IndexReader) */
public override DocValues GetCachedFieldValues(FieldCache cache, System.String field, IndexReader reader)
{
short[] arr = cache.GetShorts(reader, field, parser);
return new AnonymousClassDocValues(arr, this);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.FieldCacheSource#cachedFieldSourceEquals(Lucene.Net.Search.Function.FieldCacheSource) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.FieldCacheSource.cachedFieldSourceEquals(Lucene.Net.Search.Function.FieldCacheSource) */
public override bool CachedFieldSourceEquals(FieldCacheSource o)
{
if (o.GetType() != typeof(ShortFieldSource))
@@ -129,7 +129,7 @@ namespace Lucene.Net.Search.Function
return this.parser == null?other.parser == null:this.parser.GetType() == other.parser.GetType();
}
- /*(non-Javadoc) @see Lucene.Net.Search.Function.FieldCacheSource#cachedFieldSourceHashCode() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Function.FieldCacheSource.cachedFieldSourceHashCode() */
public override int CachedFieldSourceHashCode()
{
return parser == null?typeof(System.Int16).GetHashCode():parser.GetType().GetHashCode();
Modified: incubator/lucene.net/trunk/src/core/Search/Function/ValueSource.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/ValueSource.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/ValueSource.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/ValueSource.cs Sun Nov 6 05:24:26 2011
@@ -25,7 +25,7 @@ namespace Lucene.Net.Search.Function
/// <summary> Expert: source of values for basic function queries.
/// <p/>At its default/simplest form, values - one per doc - are used as the score of that doc.
/// <p/>Values are instantiated as
- /// {@link Lucene.Net.Search.Function.DocValues DocValues} for a particular reader.
+ /// <see cref="Lucene.Net.Search.Function.DocValues">DocValues</see> for a particular reader.
/// <p/>ValueSource implementations differ in RAM requirements: it would always be a factor
/// of the number of documents, but for each document the number of bytes can be 1, 2, 4, or 8.
///
@@ -50,19 +50,19 @@ namespace Lucene.Net.Search.Function
/// <summary> description of field, used in explain() </summary>
public abstract System.String Description();
- /* (non-Javadoc) @see java.lang.Object#toString() */
+ /* (non-Javadoc) <see cref="java.lang.Object.toString() */
public override System.String ToString()
{
return Description();
}
- /// <summary> Needed for possible caching of query results - used by {@link ValueSourceQuery#equals(Object)}.</summary>
- /// <seealso cref="Object.equals(Object)">
+ /// <summary> Needed for possible caching of query results - used by <see cref="ValueSourceQuery.Equals(Object)" />.</summary>
+ /// <seealso cref="Object.Equals(Object)">
/// </seealso>
abstract public override bool Equals(System.Object o);
- /// <summary> Needed for possible caching of query results - used by {@link ValueSourceQuery#hashCode()}.</summary>
- /// <seealso cref="Object.hashCode()">
+ /// <summary> Needed for possible caching of query results - used by <see cref="ValueSourceQuery.GetHashCode()" />.</summary>
+ /// <seealso cref="Object.GetHashCode()">
/// </seealso>
abstract public override int GetHashCode();
}
Modified: incubator/lucene.net/trunk/src/core/Search/Function/ValueSourceQuery.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Function/ValueSourceQuery.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Function/ValueSourceQuery.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Function/ValueSourceQuery.cs Sun Nov 6 05:24:26 2011
@@ -26,7 +26,7 @@ namespace Lucene.Net.Search.Function
{
/// <summary> Expert: A Query that sets the scores of document to the
- /// values obtained from a {@link Lucene.Net.Search.Function.ValueSource ValueSource}.
+ /// values obtained from a <see cref="Lucene.Net.Search.Function.ValueSource">ValueSource</see>.
/// <p/>
/// This query provides a score for <em>each and every</em> undeleted document in the index.
/// <p/>
@@ -53,13 +53,13 @@ namespace Lucene.Net.Search.Function
this.valSrc = valSrc;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Query#rewrite(Lucene.Net.Index.IndexReader) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Query.rewrite(Lucene.Net.Index.IndexReader) */
public override Query Rewrite(IndexReader reader)
{
return this;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Query#extractTerms(java.util.Set) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Query.extractTerms(java.util.Set) */
public override void ExtractTerms(System.Collections.Hashtable terms)
{
// no terms involved here
@@ -91,26 +91,26 @@ namespace Lucene.Net.Search.Function
this.similarity = Enclosing_Instance.GetSimilarity(searcher);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Weight#getQuery() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Weight.getQuery() */
public override Query GetQuery()
{
return Enclosing_Instance;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Weight#getValue() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Weight.getValue() */
public override float GetValue()
{
return queryWeight;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Weight#sumOfSquaredWeights() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Weight.sumOfSquaredWeights() */
public override float SumOfSquaredWeights()
{
queryWeight = Enclosing_Instance.GetBoost();
return queryWeight * queryWeight;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Weight#normalize(float) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Weight.normalize(float) */
public override void Normalize(float norm)
{
this.queryNorm = norm;
@@ -122,7 +122,7 @@ namespace Lucene.Net.Search.Function
return new ValueSourceScorer(enclosingInstance, similarity, reader, this);
}
- /*(non-Javadoc) @see Lucene.Net.Search.Weight#explain(Lucene.Net.Index.IndexReader, int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Weight.explain(Lucene.Net.Index.IndexReader, int) */
public override Explanation Explain(IndexReader reader, int doc)
{
return new ValueSourceScorer(enclosingInstance, similarity, reader, this).Explain(doc);
@@ -166,7 +166,7 @@ namespace Lucene.Net.Search.Function
termDocs = reader.TermDocs(null);
}
- /// <deprecated> use {@link #NextDoc()} instead.
+ /// <deprecated> use <see cref="NextDoc()" /> instead.
/// </deprecated>
[Obsolete("use NextDoc() instead. ")]
public override bool Next()
@@ -179,7 +179,7 @@ namespace Lucene.Net.Search.Function
return doc = termDocs.Next()?termDocs.Doc():NO_MORE_DOCS;
}
- /// <deprecated> use {@link #DocID()} instead.
+ /// <deprecated> use <see cref="DocID()" /> instead.
/// </deprecated>
[Obsolete("use DocID() instead.")]
public override int Doc()
@@ -192,13 +192,13 @@ namespace Lucene.Net.Search.Function
return doc;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Scorer#score() */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Scorer.score() */
public override float Score()
{
return qWeight * vals.FloatVal(termDocs.Doc());
}
- /// <deprecated> use {@link #Advance(int)} instead.
+ /// <deprecated> use <see cref="Advance(int)" /> instead.
/// </deprecated>
[Obsolete("use Advance(int)} instead.")]
public override bool SkipTo(int target)
@@ -211,7 +211,7 @@ namespace Lucene.Net.Search.Function
return doc = termDocs.SkipTo(target)?termDocs.Doc():NO_MORE_DOCS;
}
- /*(non-Javadoc) @see Lucene.Net.Search.Scorer#explain(int) */
+ /*(non-Javadoc) <see cref="Lucene.Net.Search.Scorer.explain(int) */
public override Explanation Explain(int doc)
{
float sc = qWeight * vals.FloatVal(doc);
@@ -235,7 +235,7 @@ namespace Lucene.Net.Search.Function
return valSrc.ToString() + ToStringUtils.Boost(GetBoost());
}
- /// <summary>Returns true if <code>o</code> is equal to this. </summary>
+ /// <summary>Returns true if <c>o</c> is equal to this. </summary>
public override bool Equals(System.Object o)
{
if (GetType() != o.GetType())
Modified: incubator/lucene.net/trunk/src/core/Search/FuzzyQuery.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/FuzzyQuery.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/FuzzyQuery.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/FuzzyQuery.cs Sun Nov 6 05:24:26 2011
@@ -47,8 +47,8 @@ namespace Lucene.Net.Search
new protected internal Term term;
/// <summary> Create a new FuzzyQuery that will match terms with a similarity
- /// of at least <code>minimumSimilarity</code> to <code>term</code>.
- /// If a <code>prefixLength</code> > 0 is specified, a common prefix
+ /// of at least <c>minimumSimilarity</c> to <c>term</c>.
+ /// If a <c>prefixLength</c> > 0 is specified, a common prefix
/// of that length is also required.
///
/// </summary>
@@ -56,9 +56,9 @@ namespace Lucene.Net.Search
/// </param>
/// <param name="minimumSimilarity">a value between 0 and 1 to set the required similarity
/// between the query term and the matching terms. For example, for a
- /// <code>minimumSimilarity</code> of <code>0.5</code> a term of the same length
+ /// <c>minimumSimilarity</c> of <c>0.5</c> a term of the same length
/// as the query term is considered similar to the query term if the edit distance
- /// between both terms is less than <code>length(term)*0.5</code>
+ /// between both terms is less than <c>length(term)*0.5</c>
/// </param>
/// <param name="prefixLength">length of common (non-fuzzy) prefix
/// </param>
@@ -85,13 +85,13 @@ namespace Lucene.Net.Search
this.prefixLength = prefixLength;
rewriteMethod = SCORING_BOOLEAN_QUERY_REWRITE;
}
-
- /// <summary> Calls {@link #FuzzyQuery(Term, float) FuzzyQuery(term, minimumSimilarity, 0)}.</summary>
+
+ /// <summary> Calls <see cref="FuzzyQuery(Term, float)">FuzzyQuery(term, minimumSimilarity, 0)</see>.</summary>
public FuzzyQuery(Term term, float minimumSimilarity):this(term, minimumSimilarity, defaultPrefixLength)
{
}
-
- /// <summary> Calls {@link #FuzzyQuery(Term, float) FuzzyQuery(term, 0.5f, 0)}.</summary>
+
+ /// <summary> Calls <see cref="FuzzyQuery(Term, float)">FuzzyQuery(term, 0.5f, 0)</see>.</summary>
public FuzzyQuery(Term term):this(term, defaultMinSimilarity, defaultPrefixLength)
{
}
@@ -228,7 +228,7 @@ namespace Lucene.Net.Search
}
/* (non-Javadoc)
- * @see Lucene.Net.Util.PriorityQueue#lessThan(java.lang.Object, java.lang.Object)
+ * <see cref="Lucene.Net.Util.PriorityQueue.lessThan(java.lang.Object, java.lang.Object)"/>
*/
public override bool LessThan(System.Object a, System.Object b)
{
Modified: incubator/lucene.net/trunk/src/core/Search/FuzzyTermEnum.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/FuzzyTermEnum.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/FuzzyTermEnum.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/FuzzyTermEnum.cs Sun Nov 6 05:24:26 2011
@@ -91,9 +91,9 @@ namespace Lucene.Net.Search
{
}
- /// <summary> Constructor for enumeration of all terms from specified <code>reader</code> which share a prefix of
- /// length <code>prefixLength</code> with <code>term</code> and which have a fuzzy similarity >
- /// <code>minSimilarity</code>.
+ /// <summary> Constructor for enumeration of all terms from specified <c>reader</c> which share a prefix of
+ /// length <c>prefixLength</c> with <c>term</c> and which have a fuzzy similarity >
+ /// <c>minSimilarity</c>.
/// <p/>
/// After calling the constructor the enumeration is already pointing to the first
/// valid term if such a term exists.
@@ -162,10 +162,11 @@ namespace Lucene.Net.Search
return endEnum;
}
- /// <summary>***************************
- /// Compute Levenshtein distance
- /// ****************************
- /// </summary>
+ // <summary>
+ // ***************************
+ // Compute Levenshtein distance
+ // ****************************
+ // </summary>
/// <summary> Finds and returns the smallest of three integers </summary>
private static int Min(int a, int b, int c)
@@ -187,11 +188,11 @@ namespace Lucene.Net.Search
/// <summary> <p/>Similarity returns a number that is 1.0f or less (including negative numbers)
/// based on how similar the Term is compared to a target term. It returns
/// exactly 0.0f when
- /// <pre>
- /// editDistance < maximumEditDistance</pre>
+ /// <c>
+ /// editDistance < maximumEditDistance</c>
/// Otherwise it returns:
- /// <pre>
- /// 1 - (editDistance / length)</pre>
+ /// <c>
+ /// 1 - (editDistance / length)</c>
/// where length is the length of the shortest term (text or target) including a
/// prefix that are identical and editDistance is the Levenshtein distance for
/// the two words.<p/>
@@ -202,14 +203,14 @@ namespace Lucene.Net.Search
/// mimimum distance between the words is greater than some threshold.
///
/// <p/>To calculate the maximum distance threshold we use the following formula:
- /// <pre>
- /// (1 - minimumSimilarity) * length</pre>
+ /// <c>
+ /// (1 - minimumSimilarity) * length</c>
/// where length is the shortest term including any prefix that is not part of the
/// similarity comparision. This formula was derived by solving for what maximum value
/// of distance returns false for the following statements:
- /// <pre>
+ /// <code>
/// similarity = 1 - ((float)distance / (float) (prefixLength + Math.min(textlen, targetlen)));
- /// return (similarity > minimumSimilarity);</pre>
+ /// return (similarity > minimumSimilarity);</code>
/// where distance is the Levenshtein distance for the two words.
/// <p/>
/// <p/>Levenshtein distance (also known as edit distance) is a measure of similiarity
Modified: incubator/lucene.net/trunk/src/core/Search/Hit.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Hit.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Hit.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Hit.cs Sun Nov 6 05:24:26 2011
@@ -23,11 +23,11 @@ using CorruptIndexException = Lucene.Net
namespace Lucene.Net.Search
{
- /// <summary> Wrapper used by {@link HitIterator} to provide a lazily loaded hit
- /// from {@link Hits}.
+ /// <summary> Wrapper used by <see cref="HitIterator" /> to provide a lazily loaded hit
+ /// from <see cref="Hits" />.
///
/// </summary>
- /// <deprecated> Use {@link TopScoreDocCollector} and {@link TopDocs} instead. Hits will be removed in Lucene 3.0.
+ /// <deprecated> Use <see cref="TopScoreDocCollector" /> and <see cref="TopDocs" /> instead. Hits will be removed in Lucene 3.0.
/// </deprecated>
[Obsolete("Use TopScoreDocCollector and TopDocs instead. Hits will be removed in Lucene 3.0.")]
[Serializable]
@@ -41,7 +41,7 @@ namespace Lucene.Net.Search
private Hits hits = null;
private int hitNumber;
- /// <summary> Constructed from {@link HitIterator}</summary>
+ /// <summary> Constructed from <see cref="HitIterator" /></summary>
/// <param name="hits">Hits returned from a search
/// </param>
/// <param name="hitNumber">Hit index in Hits
Modified: incubator/lucene.net/trunk/src/core/Search/HitCollector.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/HitCollector.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/HitCollector.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/HitCollector.cs Sun Nov 6 05:24:26 2011
@@ -22,7 +22,7 @@ namespace Lucene.Net.Search
/// <summary> Lower-level search API. <br/>
/// HitCollectors are primarily meant to be used to implement queries, sorting
- /// and filtering. See {@link Collector} for a lower level and higher performance
+ /// and filtering. See <see cref="Collector" /> for a lower level and higher performance
/// (on a multi-segment index) API.
///
/// </summary>
@@ -30,7 +30,7 @@ namespace Lucene.Net.Search
/// </seealso>
/// <version> $Id: HitCollector.java 764551 2009-04-13 18:33:56Z mikemccand $
/// </version>
- /// <deprecated> Please use {@link Collector} instead.
+ /// <deprecated> Please use <see cref="Collector" /> instead.
/// </deprecated>
[Obsolete("Please use Collector instead.")]
public abstract class HitCollector
@@ -39,23 +39,24 @@ namespace Lucene.Net.Search
/// number and its raw score.
///
/// <p/>If, for example, an application wished to collect all of the hits for a
- /// query in a BitSet, then it might:<pre>
+ /// query in a BitSet, then it might:
+ /// <code>
/// Searcher searcher = new IndexSearcher(indexReader);
/// final BitSet bits = new BitSet(indexReader.maxDoc());
/// searcher.search(query, new HitCollector() {
- /// public void collect(int doc, float score) {
- /// bits.set(doc);
- /// }
+ /// public void collect(int doc, float score) {
+ /// bits.set(doc);
+ /// }
/// });
- /// </pre>
+ /// </code>
///
/// <p/>Note: This is called in an inner search loop. For good search
/// performance, implementations of this method should not call
- /// {@link Searcher#Doc(int)} or
- /// {@link Lucene.Net.Index.IndexReader#Document(int)} on every
+ /// <see cref="Searcher.Doc(int)" /> or
+ /// <see cref="Lucene.Net.Index.IndexReader.Document(int)" /> on every
/// document number encountered. Doing so can slow searches by an order
/// of magnitude or more.
- /// <p/>Note: The <code>score</code> passed to this method is a raw score.
+ /// <p/>Note: The <c>score</c> passed to this method is a raw score.
/// In other words, the score will not necessarily be a float whose value is
/// between 0 and 1.
/// </summary>
Modified: incubator/lucene.net/trunk/src/core/Search/HitCollectorWrapper.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/HitCollectorWrapper.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/HitCollectorWrapper.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/HitCollectorWrapper.cs Sun Nov 6 05:24:26 2011
@@ -22,12 +22,12 @@ using IndexReader = Lucene.Net.Index.Ind
namespace Lucene.Net.Search
{
- /// <summary> Wrapper for ({@link HitCollector}) implementations, which simply re-bases the
- /// incoming docID before calling {@link HitCollector#collect}.
+ /// <summary> Wrapper for (<see cref="HitCollector" />) implementations, which simply re-bases the
+ /// incoming docID before calling <see cref="HitCollector.Collect" />.
///
/// </summary>
- /// <deprecated> Please migrate custom HitCollectors to the new {@link Collector}
- /// class. This class will be removed when {@link HitCollector} is
+ /// <deprecated> Please migrate custom HitCollectors to the new <see cref="Collector" />
+ /// class. This class will be removed when <see cref="HitCollector" /> is
/// removed.
/// </deprecated>
[Obsolete("Please migrate custom HitCollectors to the new Collector class. This class will be removed when HitCollector is removed.")]
Modified: incubator/lucene.net/trunk/src/core/Search/HitIterator.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/HitIterator.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/HitIterator.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/HitIterator.cs Sun Nov 6 05:24:26 2011
@@ -20,20 +20,20 @@ using System;
namespace Lucene.Net.Search
{
- /// <summary> An iterator over {@link Hits} that provides lazy fetching of each document.
- /// {@link Hits#Iterator()} returns an instance of this class. Calls to {@link #next()}
- /// return a {@link Hit} instance.
+ /// <summary> An iterator over <see cref="Hits" /> that provides lazy fetching of each document.
+ /// <see cref="Hits.Iterator()" /> returns an instance of this class. Calls to <see cref="Current" />
+ /// return a <see cref="Hit" /> instance.
///
/// </summary>
- /// <deprecated> Use {@link TopScoreDocCollector} and {@link TopDocs} instead. Hits will be removed in Lucene 3.0.
+ /// <deprecated> Use <see cref="TopScoreDocCollector" /> and <see cref="TopDocs" /> instead. Hits will be removed in Lucene 3.0.
/// </deprecated>
[Obsolete("Use TopScoreDocCollector and TopDocs instead. Hits will be removed in Lucene 3.0.")]
public class HitIterator : System.Collections.IEnumerator
{
- /// <summary> Returns a {@link Hit} instance representing the next hit in {@link Hits}.
+ /// <summary> Returns a <see cref="Hit" /> instance representing the next hit in <see cref="Hits" />.
///
/// </summary>
- /// <returns> Next {@link Hit}.
+ /// <returns> Next <see cref="Hit" />.
/// </returns>
public virtual System.Object Current
{
@@ -51,13 +51,13 @@ namespace Lucene.Net.Search
private Hits hits;
private int hitNumber = 0;
- /// <summary> Constructed from {@link Hits#Iterator()}.</summary>
+ /// <summary> Constructed from <see cref="Hits.Iterator()" />.</summary>
internal HitIterator(Hits hits)
{
this.hits = hits;
}
- /// <returns> true if current hit is less than the total number of {@link Hits}.
+ /// <returns> true if current hit is less than the total number of <see cref="Hits" />.
/// </returns>
public virtual bool MoveNext()
{
Modified: incubator/lucene.net/trunk/src/core/Search/HitQueue.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/HitQueue.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/HitQueue.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/HitQueue.cs Sun Nov 6 05:24:26 2011
@@ -27,15 +27,15 @@ namespace Lucene.Net.Search
private bool prePopulate;
- /// <summary> Creates a new instance with <code>size</code> elements. If
- /// <code>prePopulate</code> is set to true, the queue will pre-populate itself
- /// with sentinel objects and set its {@link #Size()} to <code>size</code>. In
- /// that case, you should not rely on {@link #Size()} to get the number of
+ /// <summary> Creates a new instance with <c>size</c> elements. If
+ /// <c>prePopulate</c> is set to true, the queue will pre-populate itself
+ /// with sentinel objects and set its <see cref="PriorityQueue.Size()" /> to <c>size</c>. In
+ /// that case, you should not rely on <see cref="PriorityQueue.Size()" /> to get the number of
/// actual elements that were added to the queue, but keep track yourself.<br/>
- /// <b>NOTE:</b> in case <code>prePopulate</code> is true, you should pop
+ /// <b>NOTE:</b> in case <c>prePopulate</c> is true, you should pop
/// elements from the queue using the following code example:
///
- /// <pre>
+ /// <code>
/// PriorityQueue pq = new HitQueue(10, true); // pre-populate.
/// ScoreDoc top = pq.top();
///
@@ -54,10 +54,10 @@ namespace Lucene.Net.Search
/// for (int i = totalHits - 1; i >= 0; i--) {
/// results[i] = (ScoreDoc) pq.pop();
/// }
- /// </pre>
+ /// </code>
///
/// <p/><b>NOTE</b>: This class pre-allocate a full array of
- /// length <code>size</code>.
+ /// length <c>size</c>.
///
/// </summary>
/// <param name="size">the requested size of this queue.
Modified: incubator/lucene.net/trunk/src/core/Search/Hits.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/Hits.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/Hits.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/Hits.cs Sun Nov 6 05:24:26 2011
@@ -28,23 +28,21 @@ namespace Lucene.Net.Search
/// <b>Caution:</b> Iterate only over the hits needed. Iterating over all hits is
/// generally not desirable and may be the source of performance issues. If you
/// need to iterate over many or all hits, consider using the search method that
- /// takes a {@link HitCollector}.
+ /// takes a <see cref="HitCollector" />.
/// <p/>
/// <p/>
/// <b>Note:</b> Deleting matching documents concurrently with traversing the
/// hits, might, when deleting hits that were not yet retrieved, decrease
- /// {@link #Length()}. In such case,
- /// {@link java.util.ConcurrentModificationException
- /// ConcurrentModificationException} is thrown when accessing hit <code>n</code>
- /// > current_{@link #Length()} (but <code>n</code> < {@link #Length()}
+ /// <see cref="Length()" />. In such case, an exceptionw is thrown when accessing hit <c>n</c>
+ /// > current_<see cref="Length()" /> (but <c>n</c> < <see cref="Length()" />
/// _at_start).
///
/// </summary>
- /// <deprecated> see {@link Searcher#Search(Query, int)},
- /// {@link Searcher#Search(Query, Filter, int)} and
- /// {@link Searcher#Search(Query, Filter, int, Sort)}:<br/>
+ /// <deprecated> see <see cref="Searcher.Search(Query, int)" />,
+ /// <see cref="Searcher.Search(Query, Filter, int)" /> and
+ /// <see cref="Searcher.Search(Query, Filter, int, Sort)" />:<br/>
///
- /// <pre>
+ /// <code>
/// TopDocs topDocs = searcher.Search(query, numHits);
/// ScoreDoc[] hits = topDocs.scoreDocs;
/// for (int i = 0; i < hits.Length; i++) {
@@ -52,7 +50,7 @@ namespace Lucene.Net.Search
/// Document d = searcher.Doc(docId);
/// // do something with current hit
/// ...
- /// </pre>
+ /// </code>
/// </deprecated>
[Obsolete("see Searcher.Search(Query, int), Searcher.Search(Query, Filter, int) and Searcher.Search(Query, Filter, int, Sort)")]
public sealed class Hits
@@ -109,7 +107,7 @@ namespace Lucene.Net.Search
}
/// <summary> Tries to add new documents to hitDocs.
- /// Ensures that the hit numbered <code>min</code> has been retrieved.
+ /// Ensures that the hit numbered <c>min</c> has been retrieved.
/// </summary>
private void GetMoreDocs(int min)
{
@@ -218,13 +216,13 @@ namespace Lucene.Net.Search
return HitDoc(n).id;
}
- /// <summary> Returns a {@link HitIterator} to navigate the Hits. Each item returned
- /// from {@link Iterator#next()} is a {@link Hit}.
+ /// <summary> Returns a <see cref="HitIterator" /> to navigate the Hits. Each item returned
+ /// from <see cref="HitIterator.Current" /> is a <see cref="Hit" />.
/// <p/>
/// <b>Caution:</b> Iterate only over the hits needed. Iterating over all
/// hits is generally not desirable and may be the source of
/// performance issues. If you need to iterate over many or all hits, consider
- /// using a search method that takes a {@link HitCollector}.
+ /// using a search method that takes a <see cref="HitCollector" />.
/// <p/>
/// </summary>
public System.Collections.IEnumerator Iterator()
Modified: incubator/lucene.net/trunk/src/core/Search/IndexSearcher.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/IndexSearcher.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/IndexSearcher.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/IndexSearcher.cs Sun Nov 6 05:24:26 2011
@@ -30,19 +30,19 @@ namespace Lucene.Net.Search
/// <summary>Implements search over a single IndexReader.
///
- /// <p/>Applications usually need only call the inherited {@link #Search(Query)}
- /// or {@link #Search(Query,Filter)} methods. For performance reasons it is
+ /// <p/>Applications usually need only call the inherited <see cref="Searcher.Search(Query)" />
+ /// or <see cref="Searcher.Search(Query,Filter)" /> methods. For performance reasons it is
/// recommended to open only one IndexSearcher and use it for all of your searches.
///
/// <p/>Note that you can only access Hits from an IndexSearcher as long as it is
/// not yet closed, otherwise an IOException will be thrown.
///
- /// <a name="thread-safety"></a><p/><b>NOTE</b>: {@link
- /// <code>IndexSearcher</code>} instances are completely
+ /// <a name="thread-safety"></a><p/><b>NOTE</b>:
+ /// <see cref="IndexSearcher" /> instances are completely
/// thread safe, meaning multiple threads can call any of its
/// methods, concurrently. If your application requires
/// external synchronization, you should <b>not</b>
- /// synchronize on the <code>IndexSearcher</code> instance;
+ /// synchronize on the <c>IndexSearcher</c> instance;
/// use your own (non-Lucene) objects instead.<p/>
/// </summary>
[Serializable]
@@ -56,7 +56,7 @@ namespace Lucene.Net.Search
/// <summary>Creates a searcher searching the index in the named directory.</summary>
/// <throws> CorruptIndexException if the index is corrupt </throws>
/// <throws> IOException if there is a low-level IO error </throws>
- /// <deprecated> Use {@link #IndexSearcher(Directory, boolean)} instead
+ /// <deprecated> Use <see cref="IndexSearcher(Directory, bool)" /> instead
/// </deprecated>
[Obsolete("Use IndexSearcher(Directory, bool) instead")]
public IndexSearcher(System.String path):this(IndexReader.Open(path), true)
@@ -76,7 +76,7 @@ namespace Lucene.Net.Search
/// </param>
/// <throws> CorruptIndexException if the index is corrupt </throws>
/// <throws> IOException if there is a low-level IO error </throws>
- /// <deprecated> Use {@link #IndexSearcher(Directory, boolean)} instead
+ /// <deprecated> Use <see cref="IndexSearcher(Directory, bool)" /> instead
/// </deprecated>
[Obsolete("Use IndexSearcher(Directory, bool) instead")]
public IndexSearcher(System.String path, bool readOnly):this(IndexReader.Open(path, readOnly), true)
@@ -86,7 +86,7 @@ namespace Lucene.Net.Search
/// <summary>Creates a searcher searching the index in the provided directory.</summary>
/// <throws> CorruptIndexException if the index is corrupt </throws>
/// <throws> IOException if there is a low-level IO error </throws>
- /// <deprecated> Use {@link #IndexSearcher(Directory, boolean)} instead
+ /// <deprecated> Use <see cref="IndexSearcher(Directory, bool)" /> instead
/// </deprecated>
[Obsolete("Use IndexSearcher(Directory, bool) instead")]
public IndexSearcher(Directory directory):this(IndexReader.Open(directory), true)
@@ -137,7 +137,7 @@ namespace Lucene.Net.Search
ReaderUtil.GatherSubReaders(allSubReaders, r);
}
- /// <summary>Return the {@link IndexReader} this searches. </summary>
+ /// <summary>Return the <see cref="IndexReader" /> this searches. </summary>
public virtual IndexReader GetIndexReader()
{
return reader;
@@ -206,15 +206,15 @@ namespace Lucene.Net.Search
return Search(weight, filter, nDocs, sort, true);
}
- /// <summary> Just like {@link #Search(Weight, Filter, int, Sort)}, but you choose
- /// whether or not the fields in the returned {@link FieldDoc} instances
+ /// <summary> Just like <see cref="Search(Weight, Filter, int, Sort)" />, but you choose
+ /// whether or not the fields in the returned <see cref="FieldDoc" /> instances
/// should be set by specifying fillFields.<br/>
///
/// <p/>
/// NOTE: this does not compute scores by default. If you need scores, create
- /// a {@link TopFieldCollector} instance by calling
- /// {@link TopFieldCollector#create} and then pass that to
- /// {@link #Search(Weight, Filter, Collector)}.
+ /// a <see cref="TopFieldCollector" /> instance by calling
+ /// <see cref="TopFieldCollector.create" /> and then pass that to
+ /// <see cref="Search(Weight, Filter, Collector)" />.
/// <p/>
/// </summary>
public virtual TopFieldDocs Search(Weight weight, Filter filter, int nDocs, Sort sort, bool fillFields)
@@ -379,13 +379,13 @@ namespace Lucene.Net.Search
private bool fieldSortDoMaxScore;
/// <summary> By default, no scores are computed when sorting by field (using
- /// {@link #Search(Query,Filter,int,Sort)}). You can change that, per
+ /// <see cref="Searcher.Search(Query,Filter,int,Sort)" />). You can change that, per
/// IndexSearcher instance, by calling this method. Note that this will incur
/// a CPU cost.
///
/// </summary>
/// <param name="doTrackScores">If true, then scores are returned for every matching document
- /// in {@link TopFieldDocs}.
+ /// in <see cref="TopFieldDocs" />.
///
/// </param>
/// <param name="doMaxScore">If true, then the max score for all matching docs is computed.
Modified: incubator/lucene.net/trunk/src/core/Search/MatchAllDocsQuery.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/MatchAllDocsQuery.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/MatchAllDocsQuery.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/MatchAllDocsQuery.cs Sun Nov 6 05:24:26 2011
@@ -77,7 +77,7 @@ namespace Lucene.Net.Search
return null; // not called... see MatchAllDocsWeight.explain()
}
- /// <deprecated> use {@link #DocID()} instead.
+ /// <deprecated> use <see cref="DocID()" /> instead.
/// </deprecated>
[Obsolete("use DocID() instead.")]
public override int Doc()
@@ -90,7 +90,7 @@ namespace Lucene.Net.Search
return doc;
}
- /// <deprecated> use {@link #NextDoc()} instead.
+ /// <deprecated> use <see cref="NextDoc()" /> instead.
/// </deprecated>
[Obsolete("use NextDoc() instead. ")]
public override bool Next()
@@ -108,7 +108,7 @@ namespace Lucene.Net.Search
return norms == null?score:score * Similarity.DecodeNorm(norms[DocID()]);
}
- /// <deprecated> use {@link #Advance(int)} instead.
+ /// <deprecated> use <see cref="Advance(int)" /> instead.
/// </deprecated>
[Obsolete("use Advance(int) instead.")]
public override bool SkipTo(int target)
Modified: incubator/lucene.net/trunk/src/core/Search/MultiPhraseQuery.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/MultiPhraseQuery.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/MultiPhraseQuery.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/MultiPhraseQuery.cs Sun Nov 6 05:24:26 2011
@@ -27,7 +27,7 @@ namespace Lucene.Net.Search
{
/// <summary> MultiPhraseQuery is a generalized version of PhraseQuery, with an added
- /// method {@link #Add(Term[])}.
+ /// method <see cref="Add(Term[])" />.
/// To use this class, to search for the phrase "Microsoft app*" first use
/// add(Term) on the term "Microsoft", then find all terms that have "app" as
/// prefix using IndexReader.terms(Term), and use MultiPhraseQuery.add(Term[]
@@ -62,7 +62,7 @@ namespace Lucene.Net.Search
}
/// <summary>Add a single term at the next position in the phrase.</summary>
- /// <seealso cref="PhraseQuery.add(Term)">
+ /// <seealso cref="PhraseQuery.Add(Term)">
/// </seealso>
public virtual void Add(Term term)
{
@@ -73,7 +73,7 @@ namespace Lucene.Net.Search
/// may match.
///
/// </summary>
- /// <seealso cref="PhraseQuery.add(Term)">
+ /// <seealso cref="PhraseQuery.Add(Term)">
/// </seealso>
public virtual void Add(Term[] terms)
{
@@ -372,7 +372,7 @@ namespace Lucene.Net.Search
}
- /// <summary>Returns true if <code>o</code> is equal to this. </summary>
+ /// <summary>Returns true if <c>o</c> is equal to this. </summary>
public override bool Equals(System.Object o)
{
if (!(o is MultiPhraseQuery))
Modified: incubator/lucene.net/trunk/src/core/Search/MultiSearcher.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Search/MultiSearcher.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Search/MultiSearcher.cs (original)
+++ incubator/lucene.net/trunk/src/core/Search/MultiSearcher.cs Sun Nov 6 05:24:26 2011
@@ -27,10 +27,10 @@ using ReaderUtil = Lucene.Net.Util.Reade
namespace Lucene.Net.Search
{
- /// <summary>Implements search over a set of <code>Searchables</code>.
+ /// <summary>Implements search over a set of <c>Searchables</c>.
///
- /// <p/>Applications usually need only call the inherited {@link #Search(Query)}
- /// or {@link #Search(Query,Filter)} methods.
+ /// <p/>Applications usually need only call the inherited <see cref="Searcher.Search(Query)" />
+ /// or <see cref="Searcher.Search(Query,Filter)" /> methods.
/// </summary>
public class MultiSearcher:Searcher
{
@@ -191,7 +191,7 @@ namespace Lucene.Net.Search
starts[searchables.Length] = maxDoc;
}
- /// <summary>Return the array of {@link Searchable}s this searches. </summary>
+ /// <summary>Return the array of <see cref="Searchable" />s this searches. </summary>
public virtual Searchable[] GetSearchables()
{
return searchables;
@@ -239,7 +239,7 @@ namespace Lucene.Net.Search
return searchables[i].Doc(n - starts[i], fieldSelector); // dispatch to searcher
}
- /// <summary>Returns index of the searcher for document <code>n</code> in the array
+ /// <summary>Returns index of the searcher for document <c>n</c> in the array
/// used to construct this searcher.
/// </summary>
public virtual int SubSearcher(int n)
@@ -248,7 +248,7 @@ namespace Lucene.Net.Search
return ReaderUtil.SubIndex(n, starts);
}
- /// <summary>Returns the document number of document <code>n</code> within its
+ /// <summary>Returns the document number of document <c>n</c> within its
/// sub-index.
/// </summary>
public virtual int SubDoc(int n)