You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2017/06/06 00:11:53 UTC
[20/48] lucenenet git commit: Lucene.Net.Queries: Fixed XML
documentation warnings
Lucene.Net.Queries: Fixed XML documentation warnings
Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/e4c37d39
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/e4c37d39
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/e4c37d39
Branch: refs/heads/master
Commit: e4c37d3972f7292091bf4249e1ffd379dcd6d61b
Parents: bed2088
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Sun Jun 4 04:06:13 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Sun Jun 4 04:06:13 2017 +0700
----------------------------------------------------------------------
src/Lucene.Net.Queries/CustomScoreProvider.cs | 4 ++--
src/Lucene.Net.Queries/CustomScoreQuery.cs | 4 ++--
.../Function/ValueSources/ByteFieldSource.cs | 2 +-
.../Function/ValueSources/DoubleFieldSource.cs | 2 +-
.../Function/ValueSources/EnumFieldSource.cs | 2 +-
.../Function/ValueSources/FloatFieldSource.cs | 2 +-
src/Lucene.Net.Queries/Function/ValueSources/IntFieldSource.cs | 2 +-
.../Function/ValueSources/LongFieldSource.cs | 2 +-
.../Function/ValueSources/ReverseOrdFieldSource.cs | 2 +-
.../Function/ValueSources/ShortFieldSource.cs | 2 +-
src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs | 6 +++---
11 files changed, 15 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/src/Lucene.Net.Queries/CustomScoreProvider.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/CustomScoreProvider.cs b/src/Lucene.Net.Queries/CustomScoreProvider.cs
index bef2eb1..75619ad 100644
--- a/src/Lucene.Net.Queries/CustomScoreProvider.cs
+++ b/src/Lucene.Net.Queries/CustomScoreProvider.cs
@@ -52,7 +52,7 @@ namespace Lucene.Net.Queries
/// Subclasses can override this method to modify the custom score.
/// <para/>
/// If your custom scoring is different than the default herein you
- /// should override at least one of the two <see cref="CustomScore"/> methods.
+ /// should override at least one of the two <see cref="CustomScore(int, float, float)"/> methods.
/// If the number of <see cref="Function.FunctionQuery"/>s is always < 2 it is
/// sufficient to override the other
/// <see cref="CustomScore(int, float, float)"/>
@@ -86,7 +86,7 @@ namespace Lucene.Net.Queries
/// Subclasses can override this method to modify the custom score.
/// <para/>
/// If your custom scoring is different than the default herein you
- /// should override at least one of the two <see cref="CustomScore"/> methods.
+ /// should override at least one of the two <see cref="CustomScore(int, float, float)"/> 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/>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/src/Lucene.Net.Queries/CustomScoreQuery.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/CustomScoreQuery.cs b/src/Lucene.Net.Queries/CustomScoreQuery.cs
index e997f3c..d7bcaba 100644
--- a/src/Lucene.Net.Queries/CustomScoreQuery.cs
+++ b/src/Lucene.Net.Queries/CustomScoreQuery.cs
@@ -29,8 +29,8 @@ namespace Lucene.Net.Queries
/// <summary>
/// Query that sets document score as a programmatic function of several (sub) scores:
/// <list type="bullet">
- /// <item>the score of its subQuery (any query)</description></item>
- /// <item>(optional) the score of its <see cref="FunctionQuery"/> (or queries).</description></item>
+ /// <item><description>the score of its subQuery (any query)</description></item>
+ /// <item><description>(optional) the score of its <see cref="FunctionQuery"/> (or queries).</description></item>
/// </list>
/// Subclasses can modify the computation by overriding <see cref="GetCustomScoreProvider"/>.
///
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/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 e7aa7c4..290c3a9 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/ByteFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/ByteFieldSource.cs
@@ -24,7 +24,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
/// <summary>
/// Obtains <see cref="int"/> field values from the <see cref="Search.FieldCache"/>
- /// using <see cref="IFieldCache.GetInt32s"/>
+ /// using <see cref="IFieldCache.GetInt32s(AtomicReader, string, FieldCache.IInt32Parser, bool)"/>
/// and makes those values available as other numeric types, casting as needed. *
/// </summary>
[Obsolete]
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/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 c986142..3534f1f 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 <see cref="double"/> field values from <see cref="IFieldCache.GetDoubles"/> and makes
+ /// Obtains <see cref="double"/> field values from <see cref="IFieldCache.GetDoubles(AtomicReader, string, FieldCache.IDoubleParser, bool)"/> 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/e4c37d39/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 bb4f4d8..cddbb4c 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/EnumFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/EnumFieldSource.cs
@@ -29,7 +29,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Obtains <see cref="int"/> field values from <see cref="IFieldCache.GetInt32s"/> and makes
+ /// Obtains <see cref="int"/> field values from <see cref="IFieldCache.GetInt32s(AtomicReader, string, FieldCache.IInt32Parser, bool)"/> and makes
/// those values available as other numeric types, casting as needed.
/// StrVal of the value is not the <see cref="int"/> value, but its <see cref="string"/> (displayed) value
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/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 26584e3..6f90cf6 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 <see cref="float"/> field values from <see cref="IFieldCache.GetFloats"/> and makes those
+ /// Obtains <see cref="float"/> field values from <see cref="IFieldCache.GetSingles(AtomicReader, string, FieldCache.ISingleParser, bool)"/> and makes those
/// values available as other numeric types, casting as needed.
/// <para/>
/// NOTE: This was FloatFieldSource in Lucene
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/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 d021256..7498cda 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 <see cref="int"/> field values from <see cref="IFieldCache.GetInt32s"/> and makes those
+ /// Obtains <see cref="int"/> field values from <see cref="IFieldCache.GetInt32s(AtomicReader, string, FieldCache.IInt32Parser, bool)"/> and makes those
/// values available as other numeric types, casting as needed.
/// <para/>
/// NOTE: This was IntFieldSource in Lucene
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/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 6c48b86..959da29 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 <see cref="long"/> field values from <see cref="IFieldCache.GetInt64s"/> and makes those
+ /// Obtains <see cref="long"/> field values from <see cref="IFieldCache.GetInt64s(AtomicReader, string, FieldCache.IInt64Parser, bool)"/> and makes those
/// values available as other numeric types, casting as needed.
/// <para/>
/// NOTE: This was LongFieldSource in Lucene
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/src/Lucene.Net.Queries/Function/ValueSources/ReverseOrdFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/ReverseOrdFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/ReverseOrdFieldSource.cs
index 3374c0c..e212dec 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/ReverseOrdFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/ReverseOrdFieldSource.cs
@@ -23,7 +23,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
*/
/// <summary>
- /// Obtains the ordinal of the field value from the default Lucene <see cref="FieldCache"/> using <see cref="IFieldCache.GetTermsIndex"/>
+ /// Obtains the ordinal of the field value from the default Lucene <see cref="FieldCache"/> using <see cref="IFieldCache.GetTermsIndex(AtomicReader, string, float)"/>
/// and reverses the order.
/// <para/>
/// The native lucene index order is used to assign an ordinal value for each field value.
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/src/Lucene.Net.Queries/Function/ValueSources/ShortFieldSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Queries/Function/ValueSources/ShortFieldSource.cs b/src/Lucene.Net.Queries/Function/ValueSources/ShortFieldSource.cs
index dab833f..04fa3fd 100644
--- a/src/Lucene.Net.Queries/Function/ValueSources/ShortFieldSource.cs
+++ b/src/Lucene.Net.Queries/Function/ValueSources/ShortFieldSource.cs
@@ -24,7 +24,7 @@ namespace Lucene.Net.Queries.Function.ValueSources
/// <summary>
/// Obtains <see cref="short"/> field values from the <see cref="FieldCache"/>
- /// using <see cref="IFieldCache.GetInt16s"/>
+ /// using <see cref="IFieldCache.GetInt16s(AtomicReader, string, FieldCache.IInt16Parser, bool)"/>
/// and makes those values available as other numeric types, casting as needed.
/// <para/>
/// NOTE: This was ShortFieldSource in Lucene
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/e4c37d39/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 f9d0312..f9effad 100644
--- a/src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs
+++ b/src/Lucene.Net.Queries/Mlt/MoreLikeThis.cs
@@ -89,7 +89,7 @@ namespace Lucene.Net.Queries.Mlt
/// <item><description>do your normal, Lucene setup for searching,</description></item>
/// <item><description>create a MoreLikeThis,</description></item>
/// <item><description>get the text of the doc you want to find similarities to</description></item>
- /// <item><description>then call one of the <see cref="Like"/> calls to generate a similarity query</description></item>
+ /// <item><description>then call one of the <see cref="Like(TextReader, string)"/> calls to generate a similarity query</description></item>
/// <item><description>call the searcher to find the similar docs</description></item>
/// </list>
/// <para/>
@@ -659,13 +659,13 @@ namespace Lucene.Net.Queries.Mlt
/// </list>
/// This is a somewhat "advanced" routine, and in general only the 1st entry in the array is of interest.
/// This method is exposed so that you can identify the "interesting words" in a document.
- /// For an easier method to call see <see cref="RetrieveInterestingTerms"/>.
+ /// For an easier method to call see <see cref="RetrieveInterestingTerms(TextReader, string)"/>.
/// </summary>
/// <param name="r"> the reader that has the content of the document </param>
/// <param name="fieldName"> field passed to the analyzer to use when analyzing the content </param>
/// <returns> the most interesting words in the document ordered by score, with the highest scoring, or best entry, first </returns>
/// <exception cref="IOException"/>
- /// <seealso cref="RetrieveInterestingTerms"/>
+ /// <seealso cref="RetrieveInterestingTerms(TextReader, string)"/>
public Util.PriorityQueue<object[]> RetrieveTerms(TextReader r, string fieldName)
{
IDictionary<string, Int32> words = new Dictionary<string, Int32>();