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/01/28 10:16:04 UTC
[21/22] lucenenet git commit: Lucene.Net.Queries: documentation
comments
Lucene.Net.Queries: documentation comments
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/4438d239
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/4438d239
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/4438d239
Branch: refs/heads/api-work
Commit: 4438d2394c625cf11b8dc7c45b209f561fbe3970
Parents: 2a6c69e
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Sat Jan 28 16:15:18 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Sat Jan 28 16:15:18 2017 +0700
----------------------------------------------------------------------
src/Lucene.Net.Queries/BooleanFilter.cs | 24 +-
src/Lucene.Net.Queries/BoostingQuery.cs | 10 +-
src/Lucene.Net.Queries/ChainedFilter.cs | 8 +-
src/Lucene.Net.Queries/CommonTermsQuery.cs | 46 ++--
src/Lucene.Net.Queries/CustomScoreProvider.cs | 67 +++--
src/Lucene.Net.Queries/CustomScoreQuery.cs | 77 +++---
src/Lucene.Net.Queries/FilterClause.cs | 16 +-
src/Lucene.Net.Queries/Function/BoostedQuery.cs | 2 +-
.../Function/DocValues/BoolDocValues.cs | 4 +-
.../DocValues/DocTermsIndexDocValues.cs | 4 +-
.../Function/DocValues/DoubleDocValues.cs | 6 +-
.../Function/DocValues/FloatDocValues.cs | 6 +-
.../Function/DocValues/IntDocValues.cs | 6 +-
.../Function/DocValues/LongDocValues.cs | 6 +-
.../Function/DocValues/StrDocValues.cs | 6 +-
.../Function/FunctionQuery.cs | 12 +-
.../Function/FunctionValues.cs | 18 +-
src/Lucene.Net.Queries/Function/ValueSource.cs | 30 +--
.../Function/ValueSourceScorer.cs | 2 +-
.../Function/ValueSources/BoolFunction.cs | 2 +-
.../Function/ValueSources/ByteFieldSource.cs | 7 +-
.../ValueSources/BytesRefFieldSource.cs | 2 +-
.../Function/ValueSources/ConstNumberSource.cs | 2 +-
.../Function/ValueSources/ConstValueSource.cs | 2 +-
.../Function/ValueSources/DefFunction.cs | 6 +-
.../Function/ValueSources/DocFreqValueSource.cs | 2 +-
.../Function/ValueSources/DoubleFieldSource.cs | 2 +-
.../Function/ValueSources/DualFloatFunction.cs | 5 +-
.../Function/ValueSources/EnumFieldSource.cs | 4 +-
.../Function/ValueSources/FieldCacheSource.cs | 6 +-
.../Function/ValueSources/FloatFieldSource.cs | 2 +-
.../Function/ValueSources/IDFValueSource.cs | 7 +-
.../Function/ValueSources/IfFunction.cs | 5 +-
.../Function/ValueSources/IntFieldSource.cs | 2 +-
.../ValueSources/LinearFloatFunction.cs | 10 +-
.../Function/ValueSources/LiteralValueSource.cs | 4 +-
.../Function/ValueSources/LongFieldSource.cs | 2 +-
.../Function/ValueSources/MaxDocValueSource.cs | 2 +-
.../Function/ValueSources/MaxFloatFunction.cs | 2 +-
.../Function/ValueSources/MinFloatFunction.cs | 2 +-
.../Function/ValueSources/MultiBoolFunction.cs | 5 +-
.../Function/ValueSources/MultiFloatFunction.cs | 5 +-
.../Function/ValueSources/MultiFunction.cs | 6 +-
.../Function/ValueSources/MultiValueSource.cs | 3 +-
.../Function/ValueSources/NormValueSource.cs | 7 +-
.../Function/ValueSources/NumDocsValueSource.cs | 2 +-
.../Function/ValueSources/OrdFieldSource.cs | 29 ++-
.../ValueSources/ProductFloatFunction.cs | 2 +-
.../Function/ValueSources/QueryValueSource.cs | 2 +-
.../ValueSources/RangeMapFloatFunction.cs | 10 +-
.../ValueSources/ReciprocalFloatFunction.cs | 23 +-
.../ValueSources/ReverseOrdFieldSource.cs | 26 +-
.../Function/ValueSources/ScaleFloatFunction.cs | 8 +-
.../Function/ValueSources/ShortFieldSource.cs | 5 +-
.../Function/ValueSources/SimpleBoolFunction.cs | 6 +-
.../ValueSources/SimpleFloatFunction.cs | 2 +-
.../Function/ValueSources/SumFloatFunction.cs | 2 +-
.../ValueSources/SumTotalTermFreqValueSource.cs | 2 +-
.../Function/ValueSources/TFValueSource.cs | 7 +-
.../ValueSources/TermFreqValueSource.cs | 5 +-
.../ValueSources/TotalTermFreqValueSource.cs | 2 +-
.../Function/ValueSources/VectorValueSource.cs | 4 +-
src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs | 260 +++++++++----------
src/Lucene.Net.Queries/Mlt/MoreLikeThisQuery.cs | 12 +-
src/Lucene.Net.Queries/TermFilter.cs | 2 +-
src/Lucene.Net.Queries/TermsFilter.cs | 10 +-
66 files changed, 407 insertions(+), 468 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/BooleanFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/BooleanFilter.cs b/src/Lucene.Net.Queries/BooleanFilter.cs
index 950d572..fdcc15f 100644
--- a/src/Lucene.Net.Queries/BooleanFilter.cs
+++ b/src/Lucene.Net.Queries/BooleanFilter.cs
@@ -26,20 +26,20 @@ namespace Lucene.Net.Queries
*/
/// <summary>
- /// A container Filter that allows Boolean composition of Filters.
- /// Filters are allocated into one of three logical constructs;
+ /// A container <see cref="Filter"/> that allows Boolean composition of <see cref="Filter"/>s.
+ /// <see cref="Filter"/>s are allocated into one of three logical constructs;
/// SHOULD, MUST NOT, MUST
- /// The results Filter BitSet is constructed as follows:
+ /// The results <see cref="Filter"/> BitSet is constructed as follows:
/// SHOULD Filters are OR'd together
- /// The resulting Filter is NOT'd with the NOT Filters
- /// The resulting Filter is AND'd with the MUST Filters
+ /// The resulting <see cref="Filter"/> is NOT'd with the NOT <see cref="Filter"/>s
+ /// The resulting <see cref="Filter"/> is AND'd with the MUST <see cref="Filter"/>s
/// </summary>
public class BooleanFilter : Filter, IEnumerable<FilterClause>
{
private readonly IList<FilterClause> clauses = new List<FilterClause>();
/// <summary>
- /// Returns the a DocIdSetIterator representing the Boolean composition
+ /// Returns the a <see cref="DocIdSetIterator"/> representing the Boolean composition
/// of the filters that have been added.
/// </summary>
public override DocIdSet GetDocIdSet(AtomicReaderContext context, IBits acceptDocs)
@@ -121,8 +121,8 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Adds a new FilterClause to the Boolean Filter container </summary>
- /// <param name="filterClause"> A FilterClause object containing a Filter and an Occur parameter </param>
+ /// Adds a new <see cref="FilterClause"/> to the Boolean <see cref="Filter"/> container </summary>
+ /// <param name="filterClause"> A <see cref="FilterClause"/> object containing a <see cref="Filter"/> and an <see cref="Occur"/> parameter </param>
public virtual void Add(FilterClause filterClause)
{
clauses.Add(filterClause);
@@ -134,7 +134,7 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Returns the list of clauses
+ /// Gets the list of clauses
/// </summary>
public virtual IList<FilterClause> Clauses
{
@@ -142,9 +142,9 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Returns an iterator on the clauses in this query. It implements the <seealso cref="Iterable"/> interface to
+ /// Returns an iterator on the clauses in this query. It implements the <see cref="IEnumerable{T}"/> interface to
/// make it possible to do:
- /// <pre class="prettyprint">for (FilterClause clause : booleanFilter) {}</pre>
+ /// <code>for (FilterClause clause : booleanFilter) {}</code>
/// </summary>
public IEnumerator<FilterClause> GetEnumerator()
{
@@ -173,7 +173,7 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Prints a user-readable version of this Filter. </summary>
+ /// Prints a user-readable version of this <see cref="Filter"/>. </summary>
public override string ToString()
{
var buffer = new StringBuilder("BooleanFilter(");
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/BoostingQuery.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/BoostingQuery.cs b/src/Lucene.Net.Queries/BoostingQuery.cs
index d74870a..364bfc5 100644
--- a/src/Lucene.Net.Queries/BoostingQuery.cs
+++ b/src/Lucene.Net.Queries/BoostingQuery.cs
@@ -21,20 +21,22 @@ namespace Lucene.Net.Queries
* limitations under the License.
*/
+
/// <summary>
- /// The BoostingQuery class can be used to effectively demote results that match a given query.
+ /// The <see cref="BoostingQuery"/> class can be used to effectively demote results that match a given query.
/// Unlike the "NOT" clause, this still selects documents that contain undesirable terms,
/// but reduces their overall score:
- ///
+ /// <code>
/// Query balancedQuery = new BoostingQuery(positiveQuery, negativeQuery, 0.01f);
+ /// </code>
/// In this scenario the positiveQuery contains the mandatory, desirable criteria which is used to
/// select all matching documents, and the negativeQuery contains the undesirable elements which
/// are simply used to lessen the scores. Documents that match the negativeQuery have their score
/// multiplied by the supplied "boost" parameter, so this should be less than 1 to achieve a
/// demoting effect
///
- /// This code was originally made available here: [WWW] http://marc.theaimsgroup.com/?l=lucene-user&m=108058407130459&w=2
- /// and is documented here: http://wiki.apache.org/lucene-java/CommunityContributions
+ /// This code was originally made available here: <c>[WWW] http://marc.theaimsgroup.com/?l=lucene-user&m=108058407130459&w=2 </c>
+ /// and is documented here: <c>http://wiki.apache.org/lucene-java/CommunityContributions</c>
/// </summary>
public class BoostingQuery : Query
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/ChainedFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/ChainedFilter.cs b/src/Lucene.Net.Queries/ChainedFilter.cs
index 01cefb7..2107d89 100644
--- a/src/Lucene.Net.Queries/ChainedFilter.cs
+++ b/src/Lucene.Net.Queries/ChainedFilter.cs
@@ -24,7 +24,7 @@ namespace Lucene.Net.Queries
/// <summary>
/// <para>
- /// Allows multiple <seealso cref="Filter"/>s to be chained.
+ /// Allows multiple <see cref="Filter"/>s to be chained.
/// Logical operations such as <b>NOT</b> and <b>XOR</b>
/// are applied between filters. One operation can be used
/// for all filters, or a specific operation can be declared
@@ -33,8 +33,8 @@ namespace Lucene.Net.Queries
/// <para>
/// Order in which filters are called depends on
/// the position of the filter in the chain. It's probably
- /// more efficient to place the most restrictive filters
- /// /least computationally-intensive filters first.
+ /// more efficient to place the most restrictive filters/least
+ /// computationally-intensive filters first.
/// </para>
/// </summary>
public class ChainedFilter : Filter
@@ -89,7 +89,7 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// <seealso cref="Filter#GetDocIdSet"/>.
+ /// <seealso cref="Filter.GetDocIdSet"/>.
/// </summary>
public override DocIdSet GetDocIdSet(AtomicReaderContext context, IBits acceptDocs)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/CommonTermsQuery.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/CommonTermsQuery.cs b/src/Lucene.Net.Queries/CommonTermsQuery.cs
index 422f56b..efab160 100644
--- a/src/Lucene.Net.Queries/CommonTermsQuery.cs
+++ b/src/Lucene.Net.Queries/CommonTermsQuery.cs
@@ -31,18 +31,18 @@ namespace Lucene.Net.Queries
/// <summary>
/// A query that executes high-frequency terms in a optional sub-query to prevent
/// slow queries due to "common" terms like stopwords. This query
- /// builds 2 queries off the <seealso cref="#add(Term) added"/> terms: low-frequency
+ /// builds 2 queries off the <see cref="Add(Term) added"/> terms: low-frequency
/// terms are added to a required boolean clause and high-frequency terms are
/// added to an optional boolean clause. The optional clause is only executed if
/// the required "low-frequency" clause matches. Scores produced by this query
- /// will be slightly different than plain <seealso cref="BooleanQuery"/> scorer mainly due to
- /// differences in the <seealso cref="Similarity#coord(int,int) number of leaf queries"/>
+ /// will be slightly different than plain <see cref="BooleanQuery"/> scorer mainly due to
+ /// differences in the <see cref="Search.Similarities.Similarity.Coord(int,int) number of leaf queries"/>
/// in the required boolean clause. In most cases, high-frequency terms are
/// unlikely to significantly contribute to the document score unless at least
/// one of the low-frequency terms are matched. This query can improve
/// query execution times significantly if applicable.
/// <para>
- /// <seealso cref="CommonTermsQuery"/> has several advantages over stopword filtering at
+ /// <see cref="CommonTermsQuery"/> has several advantages over stopword filtering at
/// index or query time since a term can be "classified" based on the actual
/// document frequency in the index and can prevent slow queries even across
/// domains without specialized stopword files.
@@ -71,41 +71,41 @@ namespace Lucene.Net.Queries
protected float m_highFreqMinNrShouldMatch = 0;
/// <summary>
- /// Creates a new <seealso cref="CommonTermsQuery"/>
+ /// Creates a new <see cref="CommonTermsQuery"/>
/// </summary>
/// <param name="highFreqOccur">
- /// <seealso cref="Occur"/> used for high frequency terms </param>
+ /// <see cref="Occur"/> used for high frequency terms </param>
/// <param name="lowFreqOccur">
- /// <seealso cref="Occur"/> used for low frequency terms </param>
+ /// <see cref="Occur"/> used for low frequency terms </param>
/// <param name="maxTermFrequency">
/// a value in [0..1) (or absolute number >=1) representing the
/// maximum threshold of a terms document frequency to be considered a
/// low frequency term. </param>
/// <exception cref="ArgumentException">
- /// if <seealso cref="Occur#MUST_NOT"/> is pass as lowFreqOccur or
- /// highFreqOccur </exception>
+ /// if <see cref="Occur.MUST_NOT"/> is pass as <paramref name="lowFreqOccur"/> or
+ /// <paramref name="highFreqOccur"/> </exception>
public CommonTermsQuery(Occur highFreqOccur, Occur lowFreqOccur, float maxTermFrequency)
: this(highFreqOccur, lowFreqOccur, maxTermFrequency, false)
{
}
/// <summary>
- /// Creates a new <seealso cref="CommonTermsQuery"/>
+ /// Creates a new <see cref="CommonTermsQuery"/>
/// </summary>
/// <param name="highFreqOccur">
- /// <seealso cref="Occur"/> used for high frequency terms </param>
+ /// <see cref="Occur"/> used for high frequency terms </param>
/// <param name="lowFreqOccur">
- /// <seealso cref="Occur"/> used for low frequency terms </param>
+ /// <see cref="Occur"/> used for low frequency terms </param>
/// <param name="maxTermFrequency">
/// a value in [0..1) (or absolute number >=1) representing the
/// maximum threshold of a terms document frequency to be considered a
/// low frequency term. </param>
/// <param name="disableCoord">
- /// disables <seealso cref="Similarity#coord(int,int)"/> in scoring for the low
+ /// disables <see cref="Search.Similarities.Similarity.Coord(int,int)"/> in scoring for the low
/// / high frequency sub-queries </param>
/// <exception cref="ArgumentException">
- /// if <seealso cref="Occur#MUST_NOT"/> is pass as lowFreqOccur or
- /// highFreqOccur </exception>
+ /// if <see cref="Occur.MUST_NOT"/> is pass as <paramref name="lowFreqOccur"/> or
+ /// <paramref name="highFreqOccur"/> </exception>
public CommonTermsQuery(Occur highFreqOccur, Occur lowFreqOccur,
float maxTermFrequency, bool disableCoord)
{
@@ -124,7 +124,7 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Adds a term to the <seealso cref="CommonTermsQuery"/>
+ /// Adds a term to the <see cref="CommonTermsQuery"/>
/// </summary>
/// <param name="term">
/// the term to add </param>
@@ -291,7 +291,7 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Returns true iff <seealso cref="Similarity#coord(int,int)"/> is disabled in scoring
+ /// Returns true iff <see cref="Search.Similarities.Similarity.Coord(int,int)"/> is disabled in scoring
/// for the high and low frequency query instance. The top level query will
/// always disable coords.
/// </summary>
@@ -304,7 +304,7 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Specifies a minimum number of the low frequent optional BooleanClauses which must be
+ /// Gets or Sets a minimum number of the low frequent optional BooleanClauses which must be
/// satisfied in order to produce a match on the low frequency terms query
/// part. This method accepts a float value in the range [0..1) as a fraction
/// of the actual query terms in the low frequent clause or a number
@@ -316,8 +316,6 @@ namespace Lucene.Net.Queries
/// clauses is required.
/// </para>
/// </summary>
- /// <param name="min">
- /// the number of optional clauses that must match </param>
public virtual float LowFreqMinimumNumberShouldMatch
{
get { return m_lowFreqMinNrShouldMatch; }
@@ -326,7 +324,7 @@ namespace Lucene.Net.Queries
/// <summary>
- /// Specifies a minimum number of the high frequent optional BooleanClauses which must be
+ /// Gets or Sets a minimum number of the high frequent optional BooleanClauses which must be
/// satisfied in order to produce a match on the low frequency terms query
/// part. This method accepts a float value in the range [0..1) as a fraction
/// of the actual query terms in the low frequent clause or a number
@@ -467,11 +465,11 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Builds a new TermQuery instance.
+ /// Builds a new <see cref="TermQuery"/> instance.
/// <para>This is intended for subclasses that wish to customize the generated queries.</para> </summary>
/// <param name="term"> term </param>
- /// <param name="context"> the TermContext to be used to create the low level term query. Can be <code>null</code>. </param>
- /// <returns> new TermQuery instance </returns>
+ /// <param name="context"> the <see cref="TermContext"/> to be used to create the low level term query. Can be <c>null</c>. </param>
+ /// <returns> new <see cref="TermQuery"/> instance </returns>
protected virtual Query NewTermQuery(Term term, TermContext context)
{
return context == null ? new TermQuery(term) : new TermQuery(term, context);
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/CustomScoreProvider.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/CustomScoreProvider.cs b/src/Lucene.Net.Queries/CustomScoreProvider.cs
index 8f32365..bef2eb1 100644
--- a/src/Lucene.Net.Queries/CustomScoreProvider.cs
+++ b/src/Lucene.Net.Queries/CustomScoreProvider.cs
@@ -23,23 +23,22 @@ namespace Lucene.Net.Queries
/// <summary>
/// An instance of this subclass should be returned by
- /// <seealso cref="CustomScoreQuery#getCustomScoreProvider"/>, if you want
- /// to modify the custom score calculation of a <seealso cref="CustomScoreQuery"/>.
- /// <para>Since Lucene 2.9, queries operate on each segment of an index separately,
- /// so the protected <seealso cref="#context"/> field can be used to resolve doc IDs,
- /// as the supplied <code>doc</code> ID is per-segment and without knowledge
- /// of the IndexReader you cannot access the document or <seealso cref="IFieldCache"/>.
+ /// <see cref="CustomScoreQuery.GetCustomScoreProvider"/>, if you want
+ /// to modify the custom score calculation of a <see cref="CustomScoreQuery"/>.
+ /// <para/>Since Lucene 2.9, queries operate on each segment of an index separately,
+ /// so the protected <see cref="m_context"/> field can be used to resolve doc IDs,
+ /// as the supplied <c>doc</c> ID is per-segment and without knowledge
+ /// of the <see cref="IndexReader"/> you cannot access the document or <see cref="IFieldCache"/>.
///
/// @lucene.experimental
/// @since 2.9.2
- /// </para>
/// </summary>
public class CustomScoreProvider
{
protected readonly AtomicReaderContext m_context;
/// <summary>
- /// Creates a new instance of the provider class for the given <seealso cref="IndexReader"/>.
+ /// Creates a new instance of the provider class for the given <see cref="IndexReader"/>.
/// </summary>
public CustomScoreProvider(AtomicReaderContext context)
{
@@ -48,29 +47,25 @@ namespace Lucene.Net.Queries
/// <summary>
/// Compute a custom score by the subQuery score and a number of
- /// <seealso cref="FunctionQuery"/> scores.
- /// <para>
+ /// <see cref="Function.FunctionQuery"/> scores.
+ /// <para/>
/// Subclasses can override this method to modify the custom score.
- /// </para>
- /// <para>
+ /// <para/>
/// If your custom scoring is different than the default herein you
- /// should override at least one of the two customScore() methods.
- /// If the number of <seealso cref="FunctionQuery function queries"/> is always < 2 it is
+ /// should override at least one of the two <see cref="CustomScore"/> methods.
+ /// If the number of <see cref="Function.FunctionQuery"/>s is always < 2 it is
/// sufficient to override the other
- /// <seealso cref="#customScore(int, float, float) customScore()"/>
+ /// <see cref="CustomScore(int, float, float)"/>
/// method, which is simpler.
- /// </para>
- /// <para>
+ /// <para/>
/// The default computation herein is a multiplication of given scores:
- /// <pre>
+ /// <code>
/// ModifiedScore = valSrcScore * valSrcScores[0] * valSrcScores[1] * ...
- /// </pre>
- ///
- /// </para>
+ /// </code>
/// </summary>
/// <param name="doc"> id of scored doc. </param>
/// <param name="subQueryScore"> score of that doc by the subQuery. </param>
- /// <param name="valSrcScores"> scores of that doc by the <seealso cref="FunctionQuery"/>. </param>
+ /// <param name="valSrcScores"> scores of that doc by the <see cref="Function.FunctionQuery"/>. </param>
/// <returns> custom score. </returns>
public virtual float CustomScore(int doc, float subQueryScore, float[] valSrcScores)
{
@@ -86,27 +81,23 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Compute a custom score by the subQuery score and the <seealso cref="FunctionQuery"/> score.
- /// <para>
+ /// Compute a custom score by the <paramref name="subQueryScore"/> and the <see cref="Function.FunctionQuery"/> score.
+ /// <para/>
/// Subclasses can override this method to modify the custom score.
- /// </para>
- /// <para>
+ /// <para/>
/// If your custom scoring is different than the default herein you
- /// should override at least one of the two customScore() methods.
- /// If the number of <seealso cref="FunctionQuery function queries"/> is always < 2 it is
- /// sufficient to override this customScore() method, which is simpler.
- /// </para>
- /// <para>
+ /// should override at least one of the two <see cref="CustomScore"/> methods.
+ /// If the number of <see cref="Function.FunctionQuery"/>s is always < 2 it is
+ /// sufficient to override this <see cref="CustomScore(int, float, float)"/> method, which is simpler.
+ /// <para/>
/// The default computation herein is a multiplication of the two scores:
- /// <pre>
+ /// <code>
/// ModifiedScore = subQueryScore * valSrcScore
- /// </pre>
- ///
- /// </para>
+ /// </code>
/// </summary>
/// <param name="doc"> id of scored doc. </param>
/// <param name="subQueryScore"> score of that doc by the subQuery. </param>
- /// <param name="valSrcScore"> score of that doc by the <seealso cref="FunctionQuery"/>. </param>
+ /// <param name="valSrcScore"> score of that doc by the <see cref="Function.FunctionQuery"/>. </param>
/// <returns> custom score. </returns>
public virtual float CustomScore(int doc, float subQueryScore, float valSrcScore)
{
@@ -115,7 +106,7 @@ namespace Lucene.Net.Queries
/// <summary>
/// Explain the custom score.
- /// Whenever overriding <seealso cref="#customScore(int, float, float[])"/>,
+ /// Whenever overriding <see cref="CustomScore(int, float, float[])"/>,
/// this method should also be overridden to provide the correct explanation
/// for the part of the custom scoring.
/// </summary>
@@ -149,7 +140,7 @@ namespace Lucene.Net.Queries
/// <summary>
/// Explain the custom score.
- /// Whenever overriding <seealso cref="#customScore(int, float, float)"/>,
+ /// Whenever overriding <see cref="CustomScore(int, float, float)"/>,
/// this method should also be overridden to provide the correct explanation
/// for the part of the custom scoring.
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/CustomScoreQuery.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/CustomScoreQuery.cs b/src/Lucene.Net.Queries/CustomScoreQuery.cs
index 461d258..6ff1e8c 100644
--- a/src/Lucene.Net.Queries/CustomScoreQuery.cs
+++ b/src/Lucene.Net.Queries/CustomScoreQuery.cs
@@ -27,11 +27,11 @@ namespace Lucene.Net.Queries
/// <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 <seealso cref="FunctionQuery"/> (or queries).</li>
- /// </ol>
- /// Subclasses can modify the computation by overriding <seealso cref="#getCustomScoreProvider"/>.
+ /// <list type="bullet">
+ /// <item>the score of its subQuery (any query)</item>
+ /// <item>(optional) the score of its <see cref="FunctionQuery"/> (or queries).</item>
+ /// </list>
+ /// Subclasses can modify the computation by overriding <see cref="GetCustomScoreProvider"/>.
///
/// @lucene.experimental
/// </summary>
@@ -42,16 +42,16 @@ namespace Lucene.Net.Queries
private bool strict = false; // if true, valueSource part of query does not take part in weights normalization.
/// <summary>
- /// Create a CustomScoreQuery over input subQuery. </summary>
- /// <param name="subQuery"> the sub query whose scored is being customized. Must not be null. </param>
+ /// Create a <see cref="CustomScoreQuery"/> over input <paramref name="subQuery"/>. </summary>
+ /// <param name="subQuery"> the sub query whose scored is being customized. Must not be <c>null</c>. </param>
public CustomScoreQuery(Query subQuery)
: this(subQuery, new FunctionQuery[0])
{
}
/// <summary>
- /// Create a CustomScoreQuery over input subQuery and a <seealso cref="FunctionQuery"/>. </summary>
- /// <param name="subQuery"> the sub query whose score is being customized. Must not be null. </param>
+ /// Create a <see cref="CustomScoreQuery"/> over input <paramref name="subQuery"/> and a <see cref="FunctionQuery"/>. </summary>
+ /// <param name="subQuery"> the sub query whose score is being customized. Must not be <c>null</c>. </param>
/// <param name="scoringQuery"> a value source query whose scores are used in the custom score
/// computation. This parameter is optional - it can be null. </param>
public CustomScoreQuery(Query subQuery, FunctionQuery scoringQuery)
@@ -61,8 +61,8 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Create a CustomScoreQuery over input subQuery and a <seealso cref="FunctionQuery"/>. </summary>
- /// <param name="subQuery"> the sub query whose score is being customized. Must not be null. </param>
+ /// Create a <see cref="CustomScoreQuery"/> over input <paramref name="subQuery"/> and a <see cref="FunctionQuery"/>. </summary>
+ /// <param name="subQuery"> the sub query whose score is being customized. Must not be <c>null</c>. </param>
/// <param name="scoringQueries"> value source queries whose scores are used in the custom score
/// computation. This parameter is optional - it can be null or even an empty array. </param>
public CustomScoreQuery(Query subQuery, params FunctionQuery[] scoringQueries)
@@ -75,6 +75,9 @@ namespace Lucene.Net.Queries
}
}
+ /// <summary>
+ /// <seealso cref="Query.Rewrite(IndexReader)"/>
+ /// </summary>
public override Query Rewrite(IndexReader reader)
{
CustomScoreQuery clone = null;
@@ -102,6 +105,9 @@ namespace Lucene.Net.Queries
return clone ?? this;
}
+ /// <summary>
+ /// <seealso cref="Query.ExtractTerms(ISet{Term})"/>
+ /// </summary>
public override void ExtractTerms(ISet<Term> terms)
{
subQuery.ExtractTerms(terms);
@@ -111,8 +117,9 @@ namespace Lucene.Net.Queries
}
}
- /*(non-Javadoc) @see org.apache.lucene.search.Query#clone() */
-
+ /// <summary>
+ /// <seealso cref="Query.Clone"/>
+ /// </summary>
public override object Clone()
{
var clone = (CustomScoreQuery)base.Clone();
@@ -125,8 +132,9 @@ namespace Lucene.Net.Queries
return clone;
}
- /* (non-Javadoc) @see org.apache.lucene.search.Query#toString(java.lang.String) */
-
+ /// <summary>
+ /// <seealso cref="Query.ToString(string)"/>
+ /// </summary>
public override string ToString(string field)
{
StringBuilder sb = (new StringBuilder(Name)).Append("(");
@@ -141,7 +149,7 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Returns true if <code>o</code> is equal to this. </summary>
+ /// Returns true if <paramref name="o"/> is equal to this. </summary>
public override bool Equals(object o)
{
if (this == o)
@@ -174,12 +182,12 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Returns a <seealso cref="CustomScoreProvider"/> that calculates the custom scores
- /// for the given <seealso cref="IndexReader"/>. The default implementation returns a default
- /// implementation as specified in the docs of <seealso cref="CustomScoreProvider"/>.
+ /// 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"/>.
/// @since 2.9.2
/// </summary>
- protected virtual CustomScoreProvider GetCustomScoreProvider(AtomicReaderContext context)
+ protected internal virtual CustomScoreProvider GetCustomScoreProvider(AtomicReaderContext context) // LUCENENET NOTE: Marked internal for documentation comments in CustomScoreProvider
{
return new CustomScoreProvider(context);
}
@@ -207,8 +215,9 @@ namespace Lucene.Net.Queries
this.qStrict = outerInstance.strict;
}
- /*(non-Javadoc) @see org.apache.lucene.search.Weight#getQuery() */
-
+ /// <summary>
+ /// <seealso cref="Weight.Query"/>
+ /// </summary>
public override Query Query
{
get { return outerInstance; }
@@ -232,8 +241,9 @@ namespace Lucene.Net.Queries
return sum;
}
- /*(non-Javadoc) @see org.apache.lucene.search.Weight#normalize(float) */
-
+ /// <summary>
+ /// <seealso cref="Weight.Normalize(float, float)"/>
+ /// </summary>
public override void Normalize(float norm, float topLevelBoost)
{
// note we DONT incorporate our boost, nor pass down any topLevelBoost
@@ -354,8 +364,9 @@ namespace Lucene.Net.Queries
get { return subQueryScorer.DocID; }
}
- /*(non-Javadoc) @see org.apache.lucene.search.Scorer#score() */
-
+ /// <summary>
+ /// <seealso cref="Scorer.GetScore"/>
+ /// </summary>
public override float GetScore()
{
for (int i = 0; i < valSrcScorers.Length; i++)
@@ -401,25 +412,25 @@ namespace Lucene.Net.Queries
/// <summary>
/// Checks if this is strict custom scoring.
- /// In strict custom scoring, the <seealso cref="ValueSource"/> part does not participate in weight normalization.
+ /// In strict custom scoring, the <see cref="ValueSource"/> part does not participate in weight normalization.
/// This may be useful when one wants full control over how scores are modified, and does
- /// not care about normalizing by the <seealso cref="ValueSource"/> part.
+ /// not care about normalizing by the <see cref="ValueSource"/> part.
/// One particular case where this is useful if for testing this query.
- /// <P>
- /// Note: only has effect when the <seealso cref="ValueSource"/> part is not null.
+ /// <para/>
+ /// Note: only has effect when the <see cref="ValueSource"/> part is not <c>null</c>.
/// </summary>
public virtual bool IsStrict { get; set; }
/// <summary>
- /// The sub-query that CustomScoreQuery wraps, affecting both the score and which documents match. </summary>
+ /// The sub-query that <see cref="CustomScoreQuery"/> wraps, affecting both the score and which documents match. </summary>
public virtual Query SubQuery
{
get { return subQuery; }
}
/// <summary>
- /// The scoring queries that only affect the score of CustomScoreQuery. </summary>
+ /// The scoring queries that only affect the score of <see cref="CustomScoreQuery"/>. </summary>
[WritableArray]
public virtual Query[] ScoringQueries
{
@@ -427,7 +438,7 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// A short name of this query, used in <seealso cref="#toString(String)"/>.
+ /// A short name of this query, used in <see cref="ToString(string)"/>.
/// </summary>
public virtual string Name
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/FilterClause.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/FilterClause.cs b/src/Lucene.Net.Queries/FilterClause.cs
index 0cbb370..2b4785b 100644
--- a/src/Lucene.Net.Queries/FilterClause.cs
+++ b/src/Lucene.Net.Queries/FilterClause.cs
@@ -20,9 +20,9 @@ namespace Lucene.Net.Queries
*/
/// <summary>
- /// A Filter that wrapped with an indication of how that filter
+ /// A <see cref="Search.Filter"/> that wrapped with an indication of how that filter
/// is used when composed with another filter.
- /// (Follows the boolean logic in BooleanClause for composition
+ /// (Follows the boolean logic in <see cref="BooleanClause"/> for composition
/// of queries.)
/// </summary>
public sealed class FilterClause
@@ -31,8 +31,8 @@ namespace Lucene.Net.Queries
private readonly Filter filter;
/// <summary>
- /// Create a new FilterClause </summary>
- /// <param name="filter"> A Filter object containing a BitSet </param>
+ /// Create a new <see cref="FilterClause"/> </summary>
+ /// <param name="filter"> A <see cref="Search.Filter"/> object containing a BitSet </param>
/// <param name="occur"> A parameter implementation indicating SHOULD, MUST or MUST NOT </param>
public FilterClause(Filter filter, Occur occur)
{
@@ -41,8 +41,8 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Returns this FilterClause's filter </summary>
- /// <returns> A Filter object </returns>
+ /// Returns this <see cref="FilterClause"/>'s filter </summary>
+ /// <returns> A <see cref="Search.Filter"/> object </returns>
public Filter Filter
{
get
@@ -52,8 +52,8 @@ namespace Lucene.Net.Queries
}
/// <summary>
- /// Returns this FilterClause's occur parameter </summary>
- /// <returns> An Occur object </returns>
+ /// Returns this <see cref="FilterClause"/>'s occur parameter </summary>
+ /// <returns> An <see cref="Search.Occur"/> object </returns>
public Occur Occur
{
get
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/BoostedQuery.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/BoostedQuery.cs b/src/Lucene.Net.Queries/Function/BoostedQuery.cs
index 9efb4f6..7afdd5c 100644
--- a/src/Lucene.Net.Queries/Function/BoostedQuery.cs
+++ b/src/Lucene.Net.Queries/Function/BoostedQuery.cs
@@ -26,7 +26,7 @@ namespace Lucene.Net.Queries.Function
*/
/// <summary>
- /// Query that is boosted by a ValueSource
+ /// Query that is boosted by a <see cref="Function.ValueSource"/>
/// </summary>
// TODO: BoostedQuery and BoostingQuery in the same module?
// something has to give
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/DocValues/BoolDocValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/DocValues/BoolDocValues.cs b/src/Lucene.Net.Queries/Function/DocValues/BoolDocValues.cs
index 417f8ee..2efbd85 100644
--- a/src/Lucene.Net.Queries/Function/DocValues/BoolDocValues.cs
+++ b/src/Lucene.Net.Queries/Function/DocValues/BoolDocValues.cs
@@ -21,8 +21,8 @@ namespace Lucene.Net.Queries.Function.DocValues
*/
/// <summary>
- /// Abstract <seealso cref="FunctionValues"/> implementation which supports retrieving boolean values.
- /// Implementations can control how the boolean values are loaded through <seealso cref="#BoolVal(int)"/>}
+ /// Abstract <see cref="FunctionValues"/> implementation which supports retrieving <see cref="bool"/> values.
+ /// Implementations can control how the <see cref="bool"/> values are loaded through <see cref="BoolVal(int)"/>
/// </summary>
public abstract class BoolDocValues : FunctionValues
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/DocValues/DocTermsIndexDocValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/DocValues/DocTermsIndexDocValues.cs b/src/Lucene.Net.Queries/Function/DocValues/DocTermsIndexDocValues.cs
index bd337d1..41f6d5e 100644
--- a/src/Lucene.Net.Queries/Function/DocValues/DocTermsIndexDocValues.cs
+++ b/src/Lucene.Net.Queries/Function/DocValues/DocTermsIndexDocValues.cs
@@ -24,7 +24,7 @@ namespace Lucene.Net.Queries.Function.DocValues
*/
/// <summary>
- /// Serves as base class for FunctionValues based on DocTermsIndex.
+ /// Serves as base class for <see cref="FunctionValues"/> based on DocTermsIndex.
/// @lucene.internal
/// </summary>
public abstract class DocTermsIndexDocValues : FunctionValues
@@ -200,7 +200,7 @@ namespace Lucene.Net.Queries.Function.DocValues
}
/// <summary>
- /// Custom Exception to be thrown when the DocTermsIndex for a field cannot be generated
+ /// Custom <see cref="Exception"/> to be thrown when the DocTermsIndex for a field cannot be generated
/// </summary>
// LUCENENET: All exeption classes should be marked serializable
#if FEATURE_SERIALIZABLE
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/DocValues/DoubleDocValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/DocValues/DoubleDocValues.cs b/src/Lucene.Net.Queries/Function/DocValues/DoubleDocValues.cs
index 3468b64..03bc61c 100644
--- a/src/Lucene.Net.Queries/Function/DocValues/DoubleDocValues.cs
+++ b/src/Lucene.Net.Queries/Function/DocValues/DoubleDocValues.cs
@@ -20,10 +20,10 @@ namespace Lucene.Net.Queries.Function.DocValues
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+
/// <summary>
- /// Abstract <seealso cref="FunctionValues"/> implementation which supports retrieving double values.
- /// Implementations can control how the double values are loaded through <seealso cref="#DoubleVal(int)"/>}
+ /// Abstract <see cref="FunctionValues"/> implementation which supports retrieving <see cref="double"/> values.
+ /// Implementations can control how the <see cref="double"/> values are loaded through <see cref="DoubleVal(int)"/>
/// </summary>
public abstract class DoubleDocValues : FunctionValues
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/DocValues/FloatDocValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/DocValues/FloatDocValues.cs b/src/Lucene.Net.Queries/Function/DocValues/FloatDocValues.cs
index 561240f..a0927af 100644
--- a/src/Lucene.Net.Queries/Function/DocValues/FloatDocValues.cs
+++ b/src/Lucene.Net.Queries/Function/DocValues/FloatDocValues.cs
@@ -19,10 +19,10 @@ namespace Lucene.Net.Queries.Function.DocValues
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+
/// <summary>
- /// Abstract <seealso cref="FunctionValues"/> implementation which supports retrieving float values.
- /// Implementations can control how the float values are loaded through <seealso cref="#FloatVal(int)"/>}
+ /// Abstract <see cref="FunctionValues"/> implementation which supports retrieving <see cref="float"/> values.
+ /// Implementations can control how the <see cref="float"/> values are loaded through <see cref="FloatVal(int)"/>
/// </summary>
public abstract class FloatDocValues : FunctionValues
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/DocValues/IntDocValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/DocValues/IntDocValues.cs b/src/Lucene.Net.Queries/Function/DocValues/IntDocValues.cs
index 60a24ef..a8c1f3b 100644
--- a/src/Lucene.Net.Queries/Function/DocValues/IntDocValues.cs
+++ b/src/Lucene.Net.Queries/Function/DocValues/IntDocValues.cs
@@ -20,10 +20,10 @@ namespace Lucene.Net.Queries.Function.DocValues
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+
/// <summary>
- /// Abstract <seealso cref="FunctionValues"/> implementation which supports retrieving int values.
- /// Implementations can control how the int values are loaded through <seealso cref="#IntVal(int)"/>
+ /// Abstract <see cref="FunctionValues"/> implementation which supports retrieving <see cref="int"/> values.
+ /// Implementations can control how the <see cref="int"/> values are loaded through <see cref="IntVal(int)"/>
/// </summary>
public abstract class IntDocValues : FunctionValues
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/DocValues/LongDocValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/DocValues/LongDocValues.cs b/src/Lucene.Net.Queries/Function/DocValues/LongDocValues.cs
index 8fecaff..081d710 100644
--- a/src/Lucene.Net.Queries/Function/DocValues/LongDocValues.cs
+++ b/src/Lucene.Net.Queries/Function/DocValues/LongDocValues.cs
@@ -20,10 +20,10 @@ namespace Lucene.Net.Queries.Function.DocValues
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+
/// <summary>
- /// Abstract <seealso cref="FunctionValues"/> implementation which supports retrieving long values.
- /// Implementations can control how the long values are loaded through <seealso cref="#LongVal(int)"/>}
+ /// Abstract <see cref="FunctionValues"/> implementation which supports retrieving <see cref="long"/> values.
+ /// Implementations can control how the <see cref="long"/> values are loaded through <see cref="LongVal(int)"/>
/// </summary>
public abstract class LongDocValues : FunctionValues
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/DocValues/StrDocValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/DocValues/StrDocValues.cs b/src/Lucene.Net.Queries/Function/DocValues/StrDocValues.cs
index 7b05226..e8a52b1 100644
--- a/src/Lucene.Net.Queries/Function/DocValues/StrDocValues.cs
+++ b/src/Lucene.Net.Queries/Function/DocValues/StrDocValues.cs
@@ -18,10 +18,10 @@ namespace Lucene.Net.Queries.Function.DocValues
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+
/// <summary>
- /// Abstract <seealso cref="FunctionValues"/> implementation which supports retrieving String values.
- /// Implementations can control how the String values are loaded through <seealso cref="#StrVal(int)"/>}
+ /// Abstract <see cref="FunctionValues"/> implementation which supports retrieving <see cref="string"/> values.
+ /// Implementations can control how the <see cref="string"/> values are loaded through <see cref="StrVal(int)"/>
/// </summary>
public abstract class StrDocValues : FunctionValues
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/FunctionQuery.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/FunctionQuery.cs b/src/Lucene.Net.Queries/Function/FunctionQuery.cs
index 11ad039..0b088e2 100644
--- a/src/Lucene.Net.Queries/Function/FunctionQuery.cs
+++ b/src/Lucene.Net.Queries/Function/FunctionQuery.cs
@@ -25,12 +25,10 @@ namespace Lucene.Net.Queries.Function
*/
/// <summary>
- /// Returns a score for each document based on a ValueSource,
+ /// Returns a score for each document based on a <see cref="Function.ValueSource"/>,
/// often some function of the value of a field.
///
/// <b>Note: This API is experimental and may change in non backward-compatible ways in the future</b>
- ///
- ///
/// </summary>
public class FunctionQuery : Query
{
@@ -42,7 +40,7 @@ namespace Lucene.Net.Queries.Function
this.func = func;
}
- /// <returns> The associated ValueSource </returns>
+ /// <returns> The associated <see cref="Function.ValueSource"/> </returns>
public virtual ValueSource ValueSource
{
get
@@ -215,7 +213,8 @@ namespace Lucene.Net.Queries.Function
/// <summary>
- /// Returns true if <code>o</code> is equal to this. </summary>
+ /// Returns true if <paramref name="o"/> is equal to this.
+ /// </summary>
public override bool Equals(object o)
{
var other = o as FunctionQuery;
@@ -228,7 +227,8 @@ namespace Lucene.Net.Queries.Function
}
/// <summary>
- /// Returns a hash code value for this object. </summary>
+ /// Returns a hash code value for this object.
+ /// </summary>
public override int GetHashCode()
{
return func.GetHashCode() * 31 + Number.FloatToIntBits(Boost);
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/FunctionValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/FunctionValues.cs b/src/Lucene.Net.Queries/Function/FunctionValues.cs
index 550f856..4ead9c8 100644
--- a/src/Lucene.Net.Queries/Function/FunctionValues.cs
+++ b/src/Lucene.Net.Queries/Function/FunctionValues.cs
@@ -25,9 +25,7 @@ namespace Lucene.Net.Queries.Function
/// <summary>
/// Represents field values as different types.
- /// Normally created via a <seealso cref="ValueSource"/> for a particular field and reader.
- ///
- ///
+ /// Normally created via a <see cref="ValueSource"/> for a particular field and reader.
/// </summary>
// FunctionValues is distinct from ValueSource because
@@ -94,7 +92,7 @@ namespace Lucene.Net.Queries.Function
}
/// <summary>
- /// Native Object representation of the value </summary>
+ /// Native <see cref="object"/> representation of the value </summary>
public virtual object ObjectVal(int doc)
{
// most FunctionValues are functions, so by default return a Float()
@@ -102,7 +100,7 @@ namespace Lucene.Net.Queries.Function
}
/// <summary>
- /// Returns true if there is a value for this document </summary>
+ /// Returns <c>true</c> if there is a value for this document </summary>
public virtual bool Exists(int doc)
{
return true;
@@ -126,20 +124,20 @@ namespace Lucene.Net.Queries.Function
/// <summary>
/// Abstraction of the logic required to fill the value of a specified doc into
- /// a reusable <seealso cref="MutableValue"/>. Implementations of <seealso cref="FunctionValues"/>
- /// are encouraged to define their own implementations of ValueFiller if their
- /// value is not a float.
+ /// a reusable <see cref="MutableValue"/>. Implementations of <see cref="FunctionValues"/>
+ /// are encouraged to define their own implementations of <see cref="ValueFiller"/> if their
+ /// value is not a <see cref="float"/>.
///
/// @lucene.experimental
/// </summary>
public abstract class ValueFiller
{
/// <summary>
- /// MutableValue will be reused across calls </summary>
+ /// <see cref="MutableValue"/> will be reused across calls </summary>
public abstract MutableValue Value { get; }
/// <summary>
- /// MutableValue will be reused across calls. Returns true if the value exists. </summary>
+ /// <see cref="MutableValue"/> will be reused across calls. Returns <c>true</c> if the value exists. </summary>
public abstract void FillValue(int doc);
}
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSource.cs
index e76a288..25616b4 100644
--- a/src/Lucene.Net.Queries/Function/ValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSource.cs
@@ -24,17 +24,15 @@ namespace Lucene.Net.Queries.Function
*/
/// <summary>
- /// Instantiates <seealso cref="FunctionValues"/> for a particular reader.
- /// <br>
- /// Often used when creating a <seealso cref="FunctionQuery"/>.
- ///
- ///
+ /// Instantiates <see cref="FunctionValues"/> for a particular reader.
+ /// <para/>
+ /// Often used when creating a <see cref="FunctionQuery"/>.
/// </summary>
public abstract class ValueSource
{
/// <summary>
/// Gets the values for this reader and the context that was previously
- /// passed to CreateWeight()
+ /// passed to <see cref="CreateWeight"/>
/// </summary>
public abstract FunctionValues GetValues(IDictionary context, AtomicReaderContext readerContext);
@@ -43,7 +41,7 @@ namespace Lucene.Net.Queries.Function
public override abstract int GetHashCode();
/// <summary>
- /// description of field, used in explain()
+ /// description of field, used in Explain()
/// </summary>
public abstract string GetDescription();
@@ -79,14 +77,12 @@ namespace Lucene.Net.Queries.Function
/// <summary>
/// EXPERIMENTAL: This method is subject to change.
- /// <para>
- /// Get the SortField for this ValueSource. Uses the <seealso cref="#GetValues(java.util.Map, AtomicReaderContext)"/>
- /// to populate the SortField.
- ///
- /// </para>
+ /// <para/>
+ /// Get the <see cref="SortField"/> for this <see cref="ValueSource"/>. Uses the <see cref="GetValues(IDictionary, AtomicReaderContext)"/>
+ /// to populate the <see cref="SortField"/>.
/// </summary>
- /// <param name="reverse"> true if this is a reverse sort. </param>
- /// <returns> The <seealso cref="org.apache.lucene.search.SortField"/> for the ValueSource </returns>
+ /// <param name="reverse"> <c>true</c> if this is a reverse sort. </param>
+ /// <returns> The <see cref="SortField"/> for the <see cref="ValueSource"/> </returns>
public virtual SortField GetSortField(bool reverse)
{
return new ValueSourceSortField(this, reverse);
@@ -129,9 +125,9 @@ namespace Lucene.Net.Queries.Function
}
/// <summary>
- /// Implement a <seealso cref="org.apache.lucene.search.FieldComparer"/> that works
- /// off of the <seealso cref="FunctionValues"/> for a ValueSource
- /// instead of the normal Lucene FieldComparer that works off of a FieldCache.
+ /// Implement a <see cref="FieldComparer"/> that works
+ /// off of the <see cref="FunctionValues"/> for a <see cref="ValueSource"/>
+ /// instead of the normal Lucene <see cref="FieldComparer"/> that works off of a <see cref="FieldCache"/>.
/// </summary>
internal class ValueSourceComparer : FieldComparer<double?>
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSourceScorer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSourceScorer.cs b/src/Lucene.Net.Queries/Function/ValueSourceScorer.cs
index 59ef2f9..cd2f0a7 100644
--- a/src/Lucene.Net.Queries/Function/ValueSourceScorer.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSourceScorer.cs
@@ -22,7 +22,7 @@ namespace Lucene.Net.Queries.Function
*/
/// <summary>
- /// <seealso cref="Scorer"/> which returns the result of <seealso cref="FunctionValues#FloatVal(int)"/> as
+ /// <see cref="Scorer"/> which returns the result of <see cref="FunctionValues.FloatVal(int)"/> as
/// the score for a document.
/// </summary>
public class ValueSourceScorer : Scorer
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/BoolFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/BoolFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/BoolFunction.cs
index 73390b9..3470fb3 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/BoolFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/BoolFunction.cs
@@ -18,7 +18,7 @@
*/
/// <summary>
- /// Abstract parent class for those <seealso cref="ValueSource"/> implementations which
+ /// Abstract parent class for those <see cref="ValueSource"/> implementations which
/// apply boolean logic to their values
/// </summary>
public abstract class BoolFunction : ValueSource
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/ByteFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/ByteFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/ByteFieldSource.cs
index 6623c41..b040454 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/ByteFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/ByteFieldSource.cs
@@ -23,16 +23,13 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Obtains int field values from the <seealso cref="org.apache.lucene.search.FieldCache"/>
- /// using <code>getInts()</code>
+ /// Obtains <see cref="int"/> field values from the <see cref="Search.FieldCache"/>
+ /// using <see cref="IFieldCache.GetInts"/>
/// and makes those values available as other numeric types, casting as needed. *
- ///
- ///
/// </summary>
[Obsolete]
public class ByteFieldSource : FieldCacheSource
{
-
private readonly FieldCache.IByteParser parser;
public ByteFieldSource(string field)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/BytesRefFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/BytesRefFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/BytesRefFieldSource.cs
index dc10900..2e137c9 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/BytesRefFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/BytesRefFieldSource.cs
@@ -23,7 +23,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// An implementation for retrieving <seealso cref="FunctionValues"/> instances for str based fields.
+ /// An implementation for retrieving <see cref="FunctionValues"/> instances for <see cref="string"/> based fields.
/// </summary>
public class BytesRefFieldSource : FieldCacheSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/ConstNumberSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/ConstNumberSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/ConstNumberSource.cs
index 5445296..90edc0a 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/ConstNumberSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/ConstNumberSource.cs
@@ -18,7 +18,7 @@
*/
/// <summary>
- /// <code>ConstNumberSource</code> is the base class for all constant numbers
+ /// <see cref="ConstNumberSource"/> is the base class for all constant numbers
/// </summary>
public abstract class ConstNumberSource : ValueSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/ConstValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/ConstValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/ConstValueSource.cs
index 507f14a..1aee2db 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/ConstValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/ConstValueSource.cs
@@ -23,7 +23,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// <code>ConstValueSource</code> returns a constant for all documents
+ /// <see cref="ConstValueSource"/> returns a constant for all documents
/// </summary>
public class ConstValueSource : ConstNumberSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/DefFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/DefFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/DefFunction.cs
index 05ed020..9f3aba2 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/DefFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/DefFunction.cs
@@ -24,9 +24,9 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// <seealso cref="ValueSource"/> implementation which only returns the values from the provided
- /// ValueSources which are available for a particular docId. Consequently, when combined
- /// with a <seealso cref="ConstValueSource"/>, this function serves as a way to return a default
+ /// <see cref="ValueSource"/> implementation which only returns the values from the provided
+ /// <see cref="ValueSource"/>s which are available for a particular docId. Consequently, when combined
+ /// with a <see cref="ConstValueSource"/>, this function serves as a way to return a default
/// value when the values for a field are unavailable.
/// </summary>
public class DefFunction : MultiFunction
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/DocFreqValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/DocFreqValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/DocFreqValueSource.cs
index acd6036..fd29bf4 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/DocFreqValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/DocFreqValueSource.cs
@@ -118,7 +118,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
/// <summary>
- /// <code>DocFreqValueSource</code> returns the number of documents containing the term.
+ /// <see cref="DocFreqValueSource"/> returns the number of documents containing the term.
/// @lucene.internal
/// </summary>
public class DocFreqValueSource : ValueSource
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/DoubleFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/DoubleFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/DoubleFieldSource.cs
index 54e70f8..c986142 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/DoubleFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/DoubleFieldSource.cs
@@ -25,7 +25,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Obtains double field values from <seealso cref="IFieldCache#getDoubles"/> and makes
+ /// Obtains <see cref="double"/> field values from <see cref="IFieldCache.GetDoubles"/> and makes
/// those values available as other numeric types, casting as needed.
/// </summary>
public class DoubleFieldSource : FieldCacheSource
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/DualFloatFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/DualFloatFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/DualFloatFunction.cs
index feec489..0b46252 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/DualFloatFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/DualFloatFunction.cs
@@ -23,9 +23,8 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Abstract <seealso cref="ValueSource"/> implementation which wraps two ValueSources
- /// and applies an extendible float function to their values.
- ///
+ /// Abstract <see cref="ValueSource"/> implementation which wraps two <see cref="ValueSource"/>s
+ /// and applies an extendible <see cref="float"/> function to their values.
/// </summary>
public abstract class DualFloatFunction : ValueSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/EnumFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/EnumFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/EnumFieldSource.cs
index 2bec9d4..4e4f32b 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/EnumFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/EnumFieldSource.cs
@@ -28,9 +28,9 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Obtains int field values from <seealso cref="IFieldCache#getInts"/> and makes
+ /// Obtains <see cref="int"/> field values from <see cref="IFieldCache.GetInts"/> and makes
/// those values available as other numeric types, casting as needed.
- /// StrVal of the value is not the int value, but its str (displayed) value
+ /// StrVal of the value is not the <see cref="int"/> value, but its <see cref="string"/> (displayed) value
/// </summary>
public class EnumFieldSource : FieldCacheSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/FieldCacheSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/FieldCacheSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/FieldCacheSource.cs
index 09efeff..cc05c64 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/FieldCacheSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/FieldCacheSource.cs
@@ -20,10 +20,8 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// A base class for ValueSource implementations that retrieve values for
- /// a single field from the <seealso cref="org.apache.lucene.search.FieldCache"/>.
- ///
- ///
+ /// A base class for <see cref="ValueSource"/> implementations that retrieve values for
+ /// a single field from the <see cref="Search.FieldCache"/>.
/// </summary>
public abstract class FieldCacheSource : ValueSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/FloatFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/FloatFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/FloatFieldSource.cs
index 43ffeac..5143b5c 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/FloatFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/FloatFieldSource.cs
@@ -25,7 +25,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Obtains float field values from <seealso cref="IFieldCache#getFloats"/> and makes those
+ /// Obtains <see cref="float"/> field values from <see cref="IFieldCache.GetFloats"/> and makes those
/// values available as other numeric types, casting as needed.
/// </summary>
public class FloatFieldSource : FieldCacheSource
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/IDFValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/IDFValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/IDFValueSource.cs
index 0b14ff5..699f191 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/IDFValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/IDFValueSource.cs
@@ -25,13 +25,12 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Function that returns <seealso cref="TFIDFSimilarity #idf(long, long)"/>
+ /// Function that returns <see cref="TFIDFSimilarity.Idf(long, long)"/>
/// for every document.
- /// <para>
+ /// <para/>
/// Note that the configured Similarity for the field must be
- /// a subclass of <seealso cref="TFIDFSimilarity"/>
+ /// a subclass of <see cref="TFIDFSimilarity"/>
/// @lucene.internal
- /// </para>
/// </summary>
[ExceptionToClassNameConvention]
public class IDFValueSource : DocFreqValueSource
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/IfFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/IfFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/IfFunction.cs
index e748b83..621449f 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/IfFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/IfFunction.cs
@@ -23,8 +23,8 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Depending on the boolean value of the <code>ifSource</code> function,
- /// returns the value of the <code>trueSource</code> or <code>falseSource</code> function.
+ /// Depending on the <see cref="bool"/> value of the <paramref name="ifSource"/> function,
+ /// returns the value of the <paramref name="trueSource"/> or <paramref name="falseSource"/> function.
/// </summary>
public class IfFunction : BoolFunction
{
@@ -32,7 +32,6 @@ namespace Lucene.Net.Queries.Function.ValueSources
private readonly ValueSource trueSource;
private readonly ValueSource falseSource;
-
public IfFunction(ValueSource ifSource, ValueSource trueSource, ValueSource falseSource)
{
this.ifSource = ifSource;
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/IntFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/IntFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/IntFieldSource.cs
index dc2a634..5d13611 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/IntFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/IntFieldSource.cs
@@ -26,7 +26,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Obtains int field values from <seealso cref="FieldCache#getInts"/> and makes those
+ /// Obtains <see cref="int"/> field values from <see cref="IFieldCache.GetInts"/> and makes those
/// values available as other numeric types, casting as needed.
/// </summary>
public class IntFieldSource : FieldCacheSource
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/LinearFloatFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/LinearFloatFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/LinearFloatFunction.cs
index bcc115c..d7cf53f 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/LinearFloatFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/LinearFloatFunction.cs
@@ -24,12 +24,10 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// <code>LinearFloatFunction</code> implements a linear function over
- /// another <seealso cref="ValueSource"/>.
- /// <br>
- /// Normally Used as an argument to a <seealso cref="FunctionQuery"/>
- ///
- ///
+ /// <see cref="LinearFloatFunction"/> implements a linear function over
+ /// another <see cref="ValueSource"/>.
+ /// <para/>
+ /// Normally Used as an argument to a <see cref="FunctionQuery"/>
/// </summary>
public class LinearFloatFunction : ValueSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/LiteralValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/LiteralValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/LiteralValueSource.cs
index f640c45..f6ca6ff 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/LiteralValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/LiteralValueSource.cs
@@ -23,9 +23,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Pass a the field value through as a String, no matter the type // Q: doesn't this mean it's a "str"?
- ///
- ///
+ /// Pass a the field value through as a <see cref="string"/>, no matter the type // Q: doesn't this mean it's a "str"?
/// </summary>
public class LiteralValueSource : ValueSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/LongFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/LongFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/LongFieldSource.cs
index 7f5e349..d13862a 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/LongFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/LongFieldSource.cs
@@ -26,7 +26,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Obtains long field values from <seealso cref="FieldCache#getLongs"/> and makes those
+ /// Obtains <see cref="long"/> field values from <see cref="IFieldCache.GetLongs"/> and makes those
/// values available as other numeric types, casting as needed.
/// </summary>
public class LongFieldSource : FieldCacheSource
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/MaxDocValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/MaxDocValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/MaxDocValueSource.cs
index 3439686..f231997 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/MaxDocValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/MaxDocValueSource.cs
@@ -22,7 +22,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Returns the value of <seealso cref="IndexReader#maxDoc()"/>
+ /// Returns the value of <see cref="IndexReader.MaxDoc"/>
/// for every document. This is the number of documents
/// including deletions.
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/MaxFloatFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/MaxFloatFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/MaxFloatFunction.cs
index 97affed..7e8913e 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/MaxFloatFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/MaxFloatFunction.cs
@@ -20,7 +20,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// <code>MaxFloatFunction</code> returns the max of it's components.
+ /// <see cref="MaxFloatFunction"/> returns the max of it's components.
/// </summary>
public class MaxFloatFunction : MultiFloatFunction
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/MinFloatFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/MinFloatFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/MinFloatFunction.cs
index daff8b1..ca5cf7b 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/MinFloatFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/MinFloatFunction.cs
@@ -20,7 +20,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// <code>MinFloatFunction</code> returns the min of it's components.
+ /// <see cref="MinFloatFunction"/> returns the min of it's components.
/// </summary>
public class MinFloatFunction : MultiFloatFunction
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/MultiBoolFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/MultiBoolFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/MultiBoolFunction.cs
index 80e734c..ad1caec 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/MultiBoolFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/MultiBoolFunction.cs
@@ -25,9 +25,8 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Abstract <seealso cref="ValueSource"/> implementation which wraps multiple ValueSources
- /// and applies an extendible boolean function to their values.
- ///
+ /// Abstract <see cref="ValueSource"/> implementation which wraps multiple <see cref="ValueSource"/>s
+ /// and applies an extendible <see cref="bool"/> function to their values.
/// </summary>
public abstract class MultiBoolFunction : BoolFunction
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/MultiFloatFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/MultiFloatFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/MultiFloatFunction.cs
index 1e0a189..c3bd1c8 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/MultiFloatFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/MultiFloatFunction.cs
@@ -25,9 +25,8 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Abstract <seealso cref="ValueSource"/> implementation which wraps multiple ValueSources
- /// and applies an extendible float function to their values.
- ///
+ /// Abstract <see cref="ValueSource"/> implementation which wraps multiple <see cref="ValueSource"/>s
+ /// and applies an extendible <see cref="float"/> function to their values.
/// </summary>
public abstract class MultiFloatFunction : ValueSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/MultiFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/MultiFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/MultiFunction.cs
index 0769519..23d909a 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/MultiFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/MultiFunction.cs
@@ -22,10 +22,10 @@ namespace Lucene.Net.Queries.Function.ValueSources
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
+
/// <summary>
- /// Abstract parent class for <seealso cref="ValueSource"/> implementations that wrap multiple
- /// ValueSources and apply their own logic.
+ /// Abstract parent class for <see cref="ValueSource"/> implementations that wrap multiple
+ /// <see cref="ValueSource"/>s and apply their own logic.
/// </summary>
public abstract class MultiFunction : ValueSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/MultiValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/MultiValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/MultiValueSource.cs
index fe59cf9..48c440b 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/MultiValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/MultiValueSource.cs
@@ -18,9 +18,8 @@
*/
/// <summary>
- /// A <seealso cref="ValueSource"/> that abstractly represents <seealso cref="ValueSource"/>s for
+ /// A <see cref="ValueSource"/> that abstractly represents <see cref="ValueSource"/>s for
/// poly fields, and other things.
- ///
/// </summary>
public abstract class MultiValueSource : ValueSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/NormValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/NormValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/NormValueSource.cs
index 79794cd..a6fcd89 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/NormValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/NormValueSource.cs
@@ -24,13 +24,12 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Function that returns <seealso cref="TFIDFSimilarity#decodeNormValue(long)"/>
+ /// Function that returns <see cref="TFIDFSimilarity.DecodeNormValue(long)"/>
/// for every document.
- /// <para>
+ /// <para/>
/// Note that the configured Similarity for the field must be
- /// a subclass of <seealso cref="TFIDFSimilarity"/>
+ /// a subclass of <see cref="TFIDFSimilarity"/>
/// @lucene.internal
- /// </para>
/// </summary>
public class NormValueSource : ValueSource
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/NumDocsValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/NumDocsValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/NumDocsValueSource.cs
index 86b77a5..f0d6531 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/NumDocsValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/NumDocsValueSource.cs
@@ -21,7 +21,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Returns the value of <seealso cref="IndexReader#numDocs()"/>
+ /// Returns the value of <see cref="IndexReader.NumDocs"/>
/// for every document. This is the number of documents
/// excluding deletions.
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/OrdFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/OrdFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/OrdFieldSource.cs
index 27cc836..cb016d7 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/OrdFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/OrdFieldSource.cs
@@ -24,24 +24,25 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Obtains the ordinal of the field value from the default Lucene <seealso cref="FieldCache"/> using getStringIndex().
- /// <br>
+ /// Obtains the ordinal of the field value from the default Lucene <see cref="FieldCache"/> using StringIndex.
+ /// <para/>
/// The native lucene index order is used to assign an ordinal value for each field value.
- /// <br>Field values (terms) are lexicographically ordered by unicode value, and numbered starting at 1.
- /// <br>
- /// Example:<br>
- /// If there were only three field values: "apple","banana","pear"
- /// <br>then ord("apple")=1, ord("banana")=2, ord("pear")=3
- /// <para>
- /// WARNING: ord() depends on the position in an index and can thus change when other documents are inserted or deleted,
- /// or if a MultiSearcher is used.
- /// <br>WARNING: as of Solr 1.4, ord() and rord() can cause excess memory use since they must use a FieldCache entry
+ /// <para/>
+ /// Field values (terms) are lexicographically ordered by unicode value, and numbered starting at 1.
+ /// <para/>
+ /// Example:
+ /// <code>
+ /// If there were only three field values: "apple","banana","pear"
+ /// then ord("apple")=1, ord("banana")=2, ord("pear")=3
+ /// </code>
+ /// <para/>
+ /// WARNING: Ord depends on the position in an index and can thus change when other documents are inserted or deleted,
+ /// or if a MultiSearcher is used.
+ /// <para/>
+ /// WARNING: as of Solr 1.4, ord() and rord() can cause excess memory use since they must use a FieldCache entry
/// at the top level reader, while sorting and function queries now use entries at the segment level. Hence sorting
/// or using a different function query, in addition to ord()/rord() will double memory use.
- ///
- /// </para>
/// </summary>
-
public class OrdFieldSource : ValueSource
{
protected readonly string m_field;
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/ProductFloatFunction.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/ProductFloatFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/ProductFloatFunction.cs
index b922228..87673f9 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/ProductFloatFunction.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/ProductFloatFunction.cs
@@ -20,7 +20,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// <code>ProductFloatFunction</code> returns the product of it's components.
+ /// <see cref="ProductFloatFunction"/> returns the product of it's components.
/// </summary>
public class ProductFloatFunction : MultiFloatFunction
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/4438d239/src/Lucene.Net.Queries/Function/ValueSources/QueryValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/QueryValueSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/QueryValueSource.cs
index 9da8e20..833f72d 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/QueryValueSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/QueryValueSource.cs
@@ -27,7 +27,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// <code>QueryValueSource</code> returns the relevance score of the query
+ /// <see cref="QueryValueSource"/> returns the relevance score of the query
/// </summary>
public class QueryValueSource : ValueSource
{