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:46 UTC
[13/48] lucenenet git commit: Lucene.Net.Analysis: Fixed XML
documentation warnings
Lucene.Net.Analysis: 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/ef2d090d
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/ef2d090d
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/ef2d090d
Branch: refs/heads/master
Commit: ef2d090dd7a743ca0c3232c574d46d19ea8052a5
Parents: b2db531
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Sat Jun 3 23:07:38 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Sat Jun 3 23:07:38 2017 +0700
----------------------------------------------------------------------
src/Lucene.Net/Analysis/Analyzer.cs | 14 ++++++++------
src/Lucene.Net/Analysis/AnalyzerWrapper.cs | 14 +++++++-------
src/Lucene.Net/Analysis/NumericTokenStream.cs | 2 +-
src/Lucene.Net/Analysis/Token.cs | 12 ++++++------
.../TokenAttributes/ICharTermAttribute.cs | 18 +++++++++---------
src/Lucene.Net/Analysis/TokenFilter.cs | 2 +-
src/Lucene.Net/Analysis/Tokenizer.cs | 2 +-
7 files changed, 33 insertions(+), 31 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ef2d090d/src/Lucene.Net/Analysis/Analyzer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Analysis/Analyzer.cs b/src/Lucene.Net/Analysis/Analyzer.cs
index 80e5ffb..a768d05 100644
--- a/src/Lucene.Net/Analysis/Analyzer.cs
+++ b/src/Lucene.Net/Analysis/Analyzer.cs
@@ -281,7 +281,7 @@ namespace Lucene.Net.Analysis
/// </summary>
/// <param name="fieldName">the name of the field the created <see cref="Analysis.TokenStream"/> is used for</param>
/// <param name="text">the <see cref="string"/> the streams source reads from </param>
- /// <returns><see cref="Analysis.TokenStream"/> for iterating the analyzed content of <paramref name="reader"/></returns>
+ /// <returns><see cref="Analysis.TokenStream"/> for iterating the analyzed content of <c>reader</c></returns>
/// <exception cref="ObjectDisposedException"> if the Analyzer is disposed. </exception>
/// <exception cref="IOException"> if an i/o error occurs (may rarely happen for strings). </exception>
/// <seealso cref="GetTokenStream(string, TextReader)"/>
@@ -425,11 +425,10 @@ namespace Lucene.Net.Analysis
/// </summary>
[Obsolete("this implementation class will be hidden in Lucene 5.0. Use Analyzer.PER_FIELD_REUSE_STRATEGY instead!")]
public class PerFieldReuseStrategy : ReuseStrategy
-
- /// <summary>
- /// Sole constructor. (For invocation by subclass constructors, typically implicit.)
- /// </summary>
{
+ /// <summary>
+ /// Sole constructor. (For invocation by subclass constructors, typically implicit.)
+ /// </summary>
[Obsolete("Don't create instances of this class, use Analyzer.PER_FIELD_REUSE_STRATEGY")]
public PerFieldReuseStrategy()
{
@@ -463,7 +462,8 @@ namespace Lucene.Net.Analysis
/// LUCENENET specific helper class to mimick Java's ability to create anonymous classes.
/// Clearly, the design of <see cref="Analyzer"/> took this feature of Java into consideration.
/// Since it doesn't exist in .NET, we can use a delegate method to call the constructor of
- /// this concrete instance to fake it (by calling <see cref="Analyzer.NewAnonymous"/>).
+ /// this concrete instance to fake it (by calling an overload of
+ /// <see cref="Analyzer.NewAnonymous(Func{string, TextReader, TokenStreamComponents})"/>).
/// </summary>
private class AnonymousAnalyzer : Analyzer
{
@@ -603,6 +603,7 @@ namespace Lucene.Net.Analysis
/// Stores the given <see cref="TokenStreamComponents"/> as the reusable components for the
/// field with the give name.
/// </summary>
+ /// <param name="analyzer"> Analyzer </param>
/// <param name="fieldName"> Name of the field whose <see cref="TokenStreamComponents"/> are being set </param>
/// <param name="components"> <see cref="TokenStreamComponents"/> which are to be reused for the field </param>
public abstract void SetReusableComponents(Analyzer analyzer, string fieldName, TokenStreamComponents components);
@@ -624,6 +625,7 @@ namespace Lucene.Net.Analysis
/// <summary>
/// Sets the stored value.
/// </summary>
+ /// <param name="analyzer"> Analyzer </param>
/// <param name="storedValue"> Value to store </param>
/// <exception cref="ObjectDisposedException"> if the <see cref="Analyzer"/> is closed. </exception>
protected internal void SetStoredValue(Analyzer analyzer, object storedValue)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ef2d090d/src/Lucene.Net/Analysis/AnalyzerWrapper.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Analysis/AnalyzerWrapper.cs b/src/Lucene.Net/Analysis/AnalyzerWrapper.cs
index de40185..5b41ed2 100644
--- a/src/Lucene.Net/Analysis/AnalyzerWrapper.cs
+++ b/src/Lucene.Net/Analysis/AnalyzerWrapper.cs
@@ -27,14 +27,14 @@ namespace Lucene.Net.Analysis
/// <see cref="GetWrappedAnalyzer(string)"/> allows the <see cref="Analyzer"/>
/// to wrap multiple <see cref="Analyzer"/>s which are selected on a per field basis.
/// <para/>
- /// <see cref="WrapComponents(string, Analyzer.TokenStreamComponents)"/> allows the
- /// <see cref="Analyzer.TokenStreamComponents"/> of the wrapped <see cref="Analyzer"/> to then be wrapped
- /// (such as adding a new <see cref="TokenFilter"/> to form new <see cref="Analyzer.TokenStreamComponents"/>).
+ /// <see cref="WrapComponents(string, TokenStreamComponents)"/> allows the
+ /// <see cref="TokenStreamComponents"/> of the wrapped <see cref="Analyzer"/> to then be wrapped
+ /// (such as adding a new <see cref="TokenFilter"/> to form new <see cref="TokenStreamComponents"/>).
/// </summary>
public abstract class AnalyzerWrapper : Analyzer
{
/// <summary>
- /// Creates a new <see cref="AnalyzerWrapper"/>. Since the <see cref="Analyzer.ReuseStrategy"/> of
+ /// Creates a new <see cref="AnalyzerWrapper"/>. Since the <see cref="ReuseStrategy"/> of
/// the wrapped <see cref="Analyzer"/>s are unknown, <see cref="Analyzer.PER_FIELD_REUSE_STRATEGY"/> is assumed.
/// </summary>
[Obsolete("Use AnalyzerWrapper(Analyzer.ReuseStrategy) and specify a valid Analyzer.ReuseStrategy, probably retrieved from the wrapped analyzer using Analyzer.Strategy.")]
@@ -66,7 +66,7 @@ namespace Lucene.Net.Analysis
protected abstract Analyzer GetWrappedAnalyzer(string fieldName);
/// <summary>
- /// Wraps / alters the given <see cref="Analyzer.TokenStreamComponents"/>, taken from the wrapped
+ /// Wraps / alters the given <see cref="TokenStreamComponents"/>, taken from the wrapped
/// <see cref="Analyzer"/>, to form new components. It is through this method that new
/// <see cref="TokenFilter"/>s can be added by <see cref="AnalyzerWrapper"/>s. By default, the given
/// components are returned.
@@ -74,8 +74,8 @@ namespace Lucene.Net.Analysis
/// <param name="fieldName">
/// Name of the field which is to be analyzed </param>
/// <param name="components">
- /// <see cref="Analyzer.TokenStreamComponents"/> taken from the wrapped <see cref="Analyzer"/> </param>
- /// <returns> Wrapped / altered <see cref="Analyzer.TokenStreamComponents"/>. </returns>
+ /// <see cref="TokenStreamComponents"/> taken from the wrapped <see cref="Analyzer"/> </param>
+ /// <returns> Wrapped / altered <see cref="TokenStreamComponents"/>. </returns>
protected virtual TokenStreamComponents WrapComponents(string fieldName, TokenStreamComponents components)
{
return components;
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ef2d090d/src/Lucene.Net/Analysis/NumericTokenStream.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Analysis/NumericTokenStream.cs b/src/Lucene.Net/Analysis/NumericTokenStream.cs
index 8615738..e616ada 100644
--- a/src/Lucene.Net/Analysis/NumericTokenStream.cs
+++ b/src/Lucene.Net/Analysis/NumericTokenStream.cs
@@ -287,7 +287,7 @@ namespace Lucene.Net.Analysis
/// <para/>
/// NOTE: This was setLongValue() in Lucene
/// </summary>
- /// <param name="value"> the value, for which this <see cref=""TokenStream/> should enumerate tokens. </param>
+ /// <param name="value"> the value, for which this <see cref="TokenStream"/> should enumerate tokens. </param>
/// <returns> this instance, because of this you can use it the following way:
/// <code>new Field(name, new NumericTokenStream(precisionStep).SetInt64Value(value))</code> </returns>
public NumericTokenStream SetInt64Value(long value)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ef2d090d/src/Lucene.Net/Analysis/Token.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Analysis/Token.cs b/src/Lucene.Net/Analysis/Token.cs
index be1938e..5f5a843 100644
--- a/src/Lucene.Net/Analysis/Token.cs
+++ b/src/Lucene.Net/Analysis/Token.cs
@@ -477,7 +477,7 @@ namespace Lucene.Net.Analysis
/// <summary>
/// Shorthand for calling <see cref="Clear"/>,
- /// <see cref="CopyBuffer(char[], int, int)"/>,
+ /// <see cref="ICharTermAttribute.CopyBuffer(char[], int, int)"/>,
/// <see cref="SetOffset"/>,
/// <see cref="Type"/> (set) </summary>
/// <returns> this <see cref="Token"/> instance </returns>
@@ -496,7 +496,7 @@ namespace Lucene.Net.Analysis
/// <summary>
/// Shorthand for calling <see cref="Clear"/>,
- /// <see cref="CopyBuffer(char[], int, int)"/>,
+ /// <see cref="ICharTermAttribute.CopyBuffer(char[], int, int)"/>,
/// <see cref="SetOffset"/>,
/// <see cref="Type"/> (set) on <see cref="TypeAttribute.DEFAULT_TYPE"/> </summary>
/// <returns> this <see cref="Token"/> instance </returns>
@@ -513,7 +513,7 @@ namespace Lucene.Net.Analysis
/// <summary>
/// Shorthand for calling <see cref="Clear"/>,
- /// <see cref="Append(string)"/>,
+ /// <see cref="ICharTermAttribute.Append(string)"/>,
/// <see cref="SetOffset"/>,
/// <see cref="Type"/> (set) </summary>
/// <returns> this <see cref="Token"/> instance </returns>
@@ -530,7 +530,7 @@ namespace Lucene.Net.Analysis
/// <summary>
/// Shorthand for calling <see cref="Clear"/>,
- /// <see cref="Append(string, int, int)"/>,
+ /// <see cref="ICharTermAttribute.Append(string, int, int)"/>,
/// <see cref="SetOffset"/>,
/// <see cref="Type"/> (set) </summary>
/// <returns> this <see cref="Token"/> instance </returns>
@@ -547,7 +547,7 @@ namespace Lucene.Net.Analysis
/// <summary>
/// Shorthand for calling <see cref="Clear"/>,
- /// <see cref="Append(string)"/>,
+ /// <see cref="ICharTermAttribute.Append(string)"/>,
/// <see cref="SetOffset"/>,
/// <see cref="Type"/> (set) on <see cref="TypeAttribute.DEFAULT_TYPE"/> </summary>
/// <returns> this <see cref="Token"/> instance </returns>
@@ -564,7 +564,7 @@ namespace Lucene.Net.Analysis
/// <summary>
/// Shorthand for calling <see cref="Clear"/>,
- /// <see cref="Append(string, int, int)"/>,
+ /// <see cref="ICharTermAttribute.Append(string, int, int)"/>,
/// <see cref="SetOffset"/>,
/// <see cref="Type"/> (set) on <see cref="TypeAttribute.DEFAULT_TYPE"/> </summary>
/// <returns> this <see cref="Token"/> instance </returns>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ef2d090d/src/Lucene.Net/Analysis/TokenAttributes/ICharTermAttribute.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Analysis/TokenAttributes/ICharTermAttribute.cs b/src/Lucene.Net/Analysis/TokenAttributes/ICharTermAttribute.cs
index 7985e55..e41404b 100644
--- a/src/Lucene.Net/Analysis/TokenAttributes/ICharTermAttribute.cs
+++ b/src/Lucene.Net/Analysis/TokenAttributes/ICharTermAttribute.cs
@@ -124,30 +124,30 @@ namespace Lucene.Net.Analysis.TokenAttributes
ICharTermAttribute Append(char c);
/// <summary>
- /// Appends the contents of the <see cref="char[]"/> array to this character sequence.
+ /// Appends the contents of the <see cref="T:char[]"/> array to this character sequence.
/// <para>
- /// The characters of the <see cref="char[]"/> argument are appended, in order, increasing the length of
+ /// The characters of the <see cref="T:char[]"/> argument are appended, in order, increasing the length of
/// this sequence by the length of the argument. If argument is <c>null</c>, then the four
/// characters <c>"null"</c> are appended.
/// </para>
/// </summary>
- /// <param name="csq">The <see cref="char[]"/> array to append.</param>
+ /// <param name="csq">The <see cref="T:char[]"/> array to append.</param>
/// <remarks>
/// LUCENENET specific method, added to simulate using the CharBuffer class in Java.
/// </remarks>
ICharTermAttribute Append(char[] csq);
/// <summary>
- /// Appends the contents of the <see cref="char[]"/> array to this character sequence, beginning and ending
+ /// Appends the contents of the <see cref="T:char[]"/> array to this character sequence, beginning and ending
/// at the specified indices.
/// <para>
- /// The characters of the <see cref="char[]"/> argument are appended, in order, increasing the length of
+ /// The characters of the <see cref="T:char[]"/> argument are appended, in order, increasing the length of
/// this sequence by the length of the argument. If argument is <c>null</c>, then the four
/// characters <c>"null"</c> are appended.
/// </para>
/// </summary>
- /// <param name="csq">The <see cref="char[]"/> array to append.</param>
- /// <param name="start">The start index of the <see cref="char[]"/> to begin copying characters.</param>
+ /// <param name="csq">The <see cref="T:char[]"/> array to append.</param>
+ /// <param name="start">The start index of the <see cref="T:char[]"/> to begin copying characters.</param>
/// <param name="end">The index of the character following the last character in the subsequence.</param>
/// <remarks>
/// LUCENENET specific method, added to simulate using the CharBuffer class in Java. Note that
@@ -201,7 +201,7 @@ namespace Lucene.Net.Analysis.TokenAttributes
/// <summary>
/// Appends the specified <see cref="StringBuilder"/> to this character sequence.
- /// <p>The characters of the <see cref="StringBuilder"/> argument are appended, in order, increasing the length of
+ /// <para/>The characters of the <see cref="StringBuilder"/> argument are appended, in order, increasing the length of
/// this sequence by the length of the argument. If argument is <c>null</c>, then the four
/// characters <c>"null"</c> are appended.
/// </summary>
@@ -213,7 +213,7 @@ namespace Lucene.Net.Analysis.TokenAttributes
/// <summary>
/// Appends the contents of the other <see cref="ICharTermAttribute"/> to this character sequence.
- /// <p>The characters of the <see cref="ICharTermAttribute"/> argument are appended, in order, increasing the length of
+ /// <para/>The characters of the <see cref="ICharTermAttribute"/> argument are appended, in order, increasing the length of
/// this sequence by the length of the argument. If argument is <c>null</c>, then the four
/// characters <c>"null"</c> are appended.
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ef2d090d/src/Lucene.Net/Analysis/TokenFilter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Analysis/TokenFilter.cs b/src/Lucene.Net/Analysis/TokenFilter.cs
index bd7e0b2..f795d33 100644
--- a/src/Lucene.Net/Analysis/TokenFilter.cs
+++ b/src/Lucene.Net/Analysis/TokenFilter.cs
@@ -39,7 +39,7 @@ namespace Lucene.Net.Analysis
/// <summary>
/// This method is called by the consumer after the last token has been
- /// consumed, after <see cref="IncrementToken()"/> returned <c>false</c>
+ /// consumed, after <see cref="TokenStream.IncrementToken()"/> returned <c>false</c>
/// (using the new <see cref="TokenStream"/> API). Streams implementing the old API
/// should upgrade to use this feature.
/// <para/>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ef2d090d/src/Lucene.Net/Analysis/Tokenizer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Analysis/Tokenizer.cs b/src/Lucene.Net/Analysis/Tokenizer.cs
index 0d2bd8c..9d9d67b 100644
--- a/src/Lucene.Net/Analysis/Tokenizer.cs
+++ b/src/Lucene.Net/Analysis/Tokenizer.cs
@@ -24,7 +24,7 @@ namespace Lucene.Net.Analysis
/// <summary>
/// A <see cref="Tokenizer"/> is a <see cref="TokenStream"/> whose input is a <see cref="TextReader"/>.
/// <para/>
- /// This is an abstract class; subclasses must override <seealso cref="#IncrementToken()"/>
+ /// This is an abstract class; subclasses must override <see cref="TokenStream.IncrementToken()"/>
/// <para/>
/// NOTE: Subclasses overriding <see cref="TokenStream.IncrementToken()"/> must
/// call <see cref="Util.AttributeSource.ClearAttributes()"/> before