Lucene.Net.Queries: fix documentation comment formatting problems
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/edecf4f5 Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/edecf4f5 Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/edecf4f5 Branch: refs/heads/api-work Commit: edecf4f54bf7e273b16b1d76d24d03228013e471 Parents: b163f89 Author: Shad Storhaug <[email protected]> Authored: Sun Feb 5 12:52:10 2017 +0700 Committer: Shad Storhaug <[email protected]> Committed: Sun Feb 5 14:47:52 2017 +0700 ---------------------------------------------------------------------- src/Lucene.Net.Queries/ChainedFilter.cs | 2 ++ src/Lucene.Net.Queries/CommonTermsQuery.cs | 6 ++---- .../Function/ValueSources/IfFunction.cs | 4 ++-- .../Function/ValueSources/RangeMapFloatFunction.cs | 2 +- .../Function/ValueSources/ScaleFloatFunction.cs | 2 +- src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs | 14 +++++++------- 6 files changed, 15 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/lucenenet/blob/edecf4f5/src/Lucene.Net.Queries/ChainedFilter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Queries/ChainedFilter.cs b/src/Lucene.Net.Queries/ChainedFilter.cs index 2107d89..50896d0 100644 --- a/src/Lucene.Net.Queries/ChainedFilter.cs +++ b/src/Lucene.Net.Queries/ChainedFilter.cs @@ -152,6 +152,7 @@ namespace Lucene.Net.Queries /// </summary> /// <param name="context"> AtomicReaderContext </param> /// <param name="logic"> Logical operation </param> + /// <param name="index"></param> /// <returns> DocIdSet </returns> private DocIdSet GetDocIdSet(AtomicReaderContext context, int logic, int[] index) { @@ -169,6 +170,7 @@ namespace Lucene.Net.Queries /// </summary> /// <param name="context"> AtomicReaderContext </param> /// <param name="logic"> Logical operation </param> + /// <param name="index"></param> /// <returns> DocIdSet </returns> private DocIdSet GetDocIdSet(AtomicReaderContext context, int[] logic, int[] index) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/edecf4f5/src/Lucene.Net.Queries/CommonTermsQuery.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Queries/CommonTermsQuery.cs b/src/Lucene.Net.Queries/CommonTermsQuery.cs index efab160..de2382b 100644 --- a/src/Lucene.Net.Queries/CommonTermsQuery.cs +++ b/src/Lucene.Net.Queries/CommonTermsQuery.cs @@ -31,12 +31,12 @@ 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 <see 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 <see cref="BooleanQuery"/> scorer mainly due to - /// differences in the <see cref="Search.Similarities.Similarity.Coord(int,int) number of leaf queries"/> + /// 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 @@ -336,8 +336,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 HighFreqMinimumNumberShouldMatch { get { return m_highFreqMinNrShouldMatch; } http://git-wip-us.apache.org/repos/asf/lucenenet/blob/edecf4f5/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 621449f..605589e 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 <see cref="bool"/> value of the <paramref name="ifSource"/> function, - /// returns the value of the <paramref name="trueSource"/> or <paramref name="falseSource"/> function. + /// Depending on the <see cref="bool"/> value of the <see cref="ifSource"/> function, + /// returns the value of the <see cref="trueSource"/> or <see cref="falseSource"/> function. /// </summary> public class IfFunction : BoolFunction { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/edecf4f5/src/Lucene.Net.Queries/Function/ValueSources/RangeMapFloatFunction.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Queries/Function/ValueSources/RangeMapFloatFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/RangeMapFloatFunction.cs index 96eec41..d510257 100644 --- a/src/Lucene.Net.Queries/Function/ValueSources/RangeMapFloatFunction.cs +++ b/src/Lucene.Net.Queries/Function/ValueSources/RangeMapFloatFunction.cs @@ -25,7 +25,7 @@ namespace Lucene.Net.Queries.Function.ValueSources /// <summary> /// <see cref="RangeMapFloatFunction"/> implements a map function over - /// another <see cref="ValueSource"/> whose values fall within <paramref name="min"/> and <paramref name="max"/> inclusive to <paramref name="target"/>. + /// another <see cref="ValueSource"/> whose values fall within <c>min</c> and <c>max</c> inclusive to <c>target</c>. /// <para/> /// Normally used as an argument to a <see cref="FunctionQuery"/> /// </summary> http://git-wip-us.apache.org/repos/asf/lucenenet/blob/edecf4f5/src/Lucene.Net.Queries/Function/ValueSources/ScaleFloatFunction.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Queries/Function/ValueSources/ScaleFloatFunction.cs b/src/Lucene.Net.Queries/Function/ValueSources/ScaleFloatFunction.cs index 9acf763..a321258 100644 --- a/src/Lucene.Net.Queries/Function/ValueSources/ScaleFloatFunction.cs +++ b/src/Lucene.Net.Queries/Function/ValueSources/ScaleFloatFunction.cs @@ -24,7 +24,7 @@ namespace Lucene.Net.Queries.Function.ValueSources */ /// <summary> - /// Scales values to be between <paramref name="min"/> and <paramref name="max"/>. + /// Scales values to be between <c>min</c> and <c>max</c>. /// <para/>This implementation currently traverses all of the source values to obtain /// their min and max. /// <para/>This implementation currently cannot distinguish when documents have been http://git-wip-us.apache.org/repos/asf/lucenenet/blob/edecf4f5/src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs b/src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs index a4dda6a..f3bfb1c 100644 --- a/src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs +++ b/src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs @@ -373,7 +373,7 @@ namespace Lucene.Net.Queries.Mlt } /// <summary> - /// Create the More like query from a <see cref="Util.PriorityQueue{Object[]}"/> + /// Create the More like query from a <see cref="T:Util.PriorityQueue{object[]}"/> /// </summary> private Query CreateQuery(Util.PriorityQueue<object[]> q) { @@ -418,7 +418,7 @@ namespace Lucene.Net.Queries.Mlt } /// <summary> - /// Create a <see cref="Util.PriorityQueue{Object[]}"/> from a word->tf map. + /// Create a <see cref="T:Util.PriorityQueue{object[]}"/> from a word->tf map. /// </summary> /// <param name="words"> a map of words keyed on the word(<see cref="string"/>) with <see cref="Int"/> objects as the values. </param> /// <exception cref="IOException"/> @@ -538,9 +538,9 @@ namespace Lucene.Net.Queries.Mlt } /// <summary> - /// Adds terms and frequencies found in vector into the <see cref="IDictionary{string, Int}"/> <paramref name="termFreqMap"/> + /// Adds terms and frequencies found in vector into the <see cref="T:IDictionary{string, Int}"/> <paramref name="termFreqMap"/> /// </summary> - /// <param name="termFreqMap"> a <see cref="IDictionary{string, Int}"/> of terms and their frequencies </param> + /// <param name="termFreqMap"> a <see cref="T:IDictionary{string, Int}"/> of terms and their frequencies </param> /// <param name="vector"> List of terms and their frequencies for a doc/field </param> private void AddTermFrequencies(IDictionary<string, Int> termFreqMap, Terms vector) { @@ -573,10 +573,10 @@ namespace Lucene.Net.Queries.Mlt } /// <summary> - /// Adds term frequencies found by tokenizing text from reader into the <see cref="IDictionary{string, Int}"/> words + /// Adds term frequencies found by tokenizing text from reader into the <see cref="T:IDictionary{string, Int}"/> words /// </summary> /// <param name="r"> a source of text to be tokenized </param> - /// <param name="termFreqMap"> a <see cref="IDictionary{string, Int}"/> of terms and their frequencies </param> + /// <param name="termFreqMap"> a <see cref="T:IDictionary{string, Int}"/> of terms and their frequencies </param> /// <param name="fieldName"> Used by analyzer for any special per-field analysis </param> private void AddTermFrequencies(TextReader r, IDictionary<string, Int> termFreqMap, string fieldName) { @@ -714,7 +714,7 @@ namespace Lucene.Net.Queries.Mlt } /// <summary> - /// <see cref="Util.PriorityQueue{object[]}"/> that orders words by score. + /// <see cref="T:Util.PriorityQueue{object[]}"/> that orders words by score. /// </summary> private class FreqQ : Util.PriorityQueue<object[]> {
