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/02/04 20:32:24 UTC
[05/39] lucenenet git commit: Lucene.Net.Analysis.Standard refactor:
member accessibility and documentation comments
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ab69b431/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/StandardTokenizerImpl34.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/StandardTokenizerImpl34.cs b/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/StandardTokenizerImpl34.cs
index fd446a3..855470d 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/StandardTokenizerImpl34.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/StandardTokenizerImpl34.cs
@@ -29,26 +29,26 @@ namespace Lucene.Net.Analysis.Standard.Std34
[Obsolete("This class is only for exact backwards compatibility")]
public sealed class StandardTokenizerImpl34 : IStandardTokenizerInterface
{
- /** This character denotes the end of file */
+ /// <summary>This character denotes the end of file</summary>
public static readonly int YYEOF = -1;
- /** initial size of the lookahead buffer */
+ /// <summary>initial size of the lookahead buffer</summary>
private static readonly int ZZ_BUFFERSIZE = 4096;
- /** lexical states */
+ /// <summary>lexical states</summary>
public const int YYINITIAL = 0;
- /**
- * ZZ_LEXSTATE[l] is the state in the DFA for the lexical state l
- * ZZ_LEXSTATE[l+1] is the state in the DFA for the lexical state l
- * at the beginning of a line
- * l is of the form l = 2*k, k a non negative integer
- */
+ /// <summary>
+ /// ZZ_LEXSTATE[l] is the state in the DFA for the lexical state l
+ /// ZZ_LEXSTATE[l+1] is the state in the DFA for the lexical state l
+ /// at the beginning of a line
+ /// l is of the form l = 2*k, k a non negative integer
+ /// </summary>
private static readonly int[] ZZ_LEXSTATE = { 0, 0 };
- /**
- * Translates characters to character classes
- */
+ /// <summary>
+ /// Translates characters to character classes
+ /// </summary>
private const string ZZ_CMAP_PACKED =
"\x0027\x0000\x0001\x0060\x0004\x0000\x0001\x005F\x0001\x0000\x0001\x0060\x0001\x0000\x000A\x005C\x0001\x005E\x0001\x005F" +
"\x0005\x0000\x001A\x005A\x0004\x0000\x0001\x0061\x0001\x0000\x001A\x005A\x002F\x0000\x0001\x005A\x0002\x0000\x0001\x005B" +
@@ -184,14 +184,14 @@ namespace Lucene.Net.Analysis.Standard.Std34
"\x000B\x0000\x0038\x005D\x0002\x005B\x001F\x0066\x0003\x0000\x0006\x0066\x0002\x0000\x0006\x0066\x0002\x0000\x0006\x0066" +
"\x0002\x0000\x0003\x0066\x001C\x0000\x0003\x005B\x0004\x0000";
- /**
- * Translates characters to character classes
- */
+ /// <summary>
+ /// Translates characters to character classes
+ /// </summary>
private static readonly char[] ZZ_CMAP = ZzUnpackCMap(ZZ_CMAP_PACKED);
- /**
- * Translates DFA states to action switch labels.
- */
+ /// <summary>
+ /// Translates DFA states to action switch labels.
+ /// </summary>
private static readonly int[] ZZ_ACTION = ZzUnpackAction();
private const string ZZ_ACTION_PACKED_0 =
@@ -222,9 +222,9 @@ namespace Lucene.Net.Analysis.Standard.Std34
}
- /**
- * Translates a state to a row index in the transition table
- */
+ /// <summary>
+ /// Translates a state to a row index in the transition table
+ /// </summary>
private static readonly int[] ZZ_ROWMAP = ZzUnpackRowMap();
private const string ZZ_ROWMAP_PACKED_0 =
@@ -266,9 +266,9 @@ namespace Lucene.Net.Analysis.Standard.Std34
return j;
}
- /**
- * The transition table of the DFA
- */
+ /// <summary>
+ /// The transition table of the DFA
+ /// </summary>
private static readonly int[] ZZ_TRANS = ZzUnpackTrans();
private const string ZZ_TRANS_PACKED_0 =
@@ -631,9 +631,9 @@ namespace Lucene.Net.Analysis.Standard.Std34
"Error: pushback value was too large"
};
- /**
- * ZZ_ATTRIBUTE[aState] contains the attributes of state <code>aState</code>
- */
+ /// <summary>
+ /// ZZ_ATTRIBUTE[aState] contains the attributes of state <c>aState</c>
+ /// </summary>
private static readonly int[] ZZ_ATTRIBUTE = ZzUnpackAttribute();
private const string ZZ_ATTRIBUTE_PACKED_0 =
@@ -662,73 +662,78 @@ namespace Lucene.Net.Analysis.Standard.Std34
return j;
}
- /** the input device */
+ /// <summary>the input device</summary>
private TextReader zzReader;
- /** the current state of the DFA */
+ /// <summary>the current state of the DFA</summary>
private int zzState;
- /** the current lexical state */
+ /// <summary>the current lexical state</summary>
private int zzLexicalState = YYINITIAL;
- /** this buffer contains the current text to be matched and is
- the source of the YyText() string */
+ /// <summary>
+ /// this buffer contains the current text to be matched and is
+ /// the source of the YyText string
+ /// </summary>
private char[] zzBuffer = new char[ZZ_BUFFERSIZE];
- /** the textposition at the last accepting state */
+ /// <summary>the textposition at the last accepting state</summary>
private int zzMarkedPos;
- /** the current text position in the buffer */
+ /// <summary>the current text position in the buffer</summary>
private int zzCurrentPos;
- /** startRead marks the beginning of the YyText() string in the buffer */
+ /// <summary>startRead marks the beginning of the YyText string in the buffer</summary>
private int zzStartRead;
- /** endRead marks the last character in the buffer, that has been read
- from input */
+ /// <summary>
+ /// endRead marks the last character in the buffer, that has been read
+ /// from input
+ /// </summary>
private int zzEndRead;
- /** number of newlines encountered up to the start of the matched text */
+ /// <summary>number of newlines encountered up to the start of the matched text</summary>
private int yyline;
- /** the number of characters up to the start of the matched text */
+ /// <summary>the number of characters up to the start of the matched text</summary>
private int yyChar;
#pragma warning disable 169, 414
- /**
- * the number of characters from the last newline up to the start of the
- * matched text
- */
+
+ /// <summary>
+ /// the number of characters from the last newline up to the start of the
+ /// matched text
+ /// </summary>
private int yycolumn;
- /**
- * zzAtBOL == true <=> the scanner is currently at the beginning of a line
- */
+ /// <summary>
+ /// zzAtBOL == true <=> the scanner is currently at the beginning of a line
+ /// </summary>
private bool zzAtBOL = true;
- /** zzAtEOF == true <=> the scanner is at the EOF */
+ /// <summary>zzAtEOF == true <=> the scanner is at the EOF</summary>
private bool zzAtEOF;
- /** denotes if the user-EOF-code has already been executed */
+ /// <summary>denotes if the user-EOF-code has already been executed</summary>
private bool zzEOFDone;
#pragma warning restore 169, 414
/* user code: */
- /** Alphanumeric sequences */
+ /// <summary>Alphanumeric sequences</summary>
public static readonly int WORD_TYPE = StandardTokenizer.ALPHANUM;
- /** Numbers */
+ /// <summary>Numbers</summary>
public static readonly int NUMERIC_TYPE = StandardTokenizer.NUM;
- /**
- * Chars in class \p{Line_Break = Complex_Context} are from South East Asian
- * scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept
- * together as as a single token rather than broken up, because the logic
- * required to break them at word boundaries is too complex for UAX#29.
- * <p>
- * See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
- */
+ /// <summary>
+ /// Chars in class \p{Line_Break = Complex_Context} are from South East Asian
+ /// scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept
+ /// together as as a single token rather than broken up, because the logic
+ /// required to break them at word boundaries is too complex for UAX#29.
+ /// <para/>
+ /// See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
+ /// </summary>
public static readonly int SOUTH_EAST_ASIAN_TYPE = StandardTokenizer.SOUTHEAST_ASIAN;
public static readonly int IDEOGRAPHIC_TYPE = StandardTokenizer.IDEOGRAPHIC;
@@ -744,32 +749,28 @@ namespace Lucene.Net.Analysis.Standard.Std34
get { return yyChar; }
}
- /**
- * Fills CharTermAttribute with the current token text.
- */
+ /// <summary>
+ /// Fills ICharTermAttribute with the current token text.
+ /// </summary>
public void GetText(ICharTermAttribute t)
{
t.CopyBuffer(zzBuffer, zzStartRead, zzMarkedPos - zzStartRead);
}
-
- /**
- * Creates a new scanner
- *
- * @param in the TextReader to read input from.
- */
+ /// <summary>
+ /// Creates a new scanner
+ /// </summary>
+ /// <param name="in">the TextReader to read input from.</param>
public StandardTokenizerImpl34(TextReader @in)
{
this.zzReader = @in;
}
-
- /**
- * Unpacks the compressed character translation table.
- *
- * @param packed the packed character translation table
- * @return the unpacked character translation table
- */
+ /// <summary>
+ /// Unpacks the compressed character translation table.
+ /// </summary>
+ /// <param name="packed">the packed character translation table</param>
+ /// <returns>the unpacked character translation table</returns>
private static char[] ZzUnpackCMap(string packed)
{
char[] map = new char[0x10000];
@@ -784,14 +785,11 @@ namespace Lucene.Net.Analysis.Standard.Std34
return map;
}
-
- /**
- * Refills the input buffer.
- *
- * @return <code>false</code>, iff there was new input.
- *
- * @exception java.io.IOException if any I/O-Error occurs
- */
+ /// <summary>
+ /// Refills the input buffer.
+ /// </summary>
+ /// <returns><c>false</c>, iff there was new input.</returns>
+ /// <exception cref="IOException">if any I/O-Error occurs</exception>
private bool ZzRefill()
{
@@ -847,9 +845,9 @@ namespace Lucene.Net.Analysis.Standard.Std34
}
- /**
- * Closes the input stream.
- */
+ /// <summary>
+ /// Disposes the input stream.
+ /// </summary>
public void YyClose()
{
zzAtEOF = true; /* indicate end of file */
@@ -859,19 +857,17 @@ namespace Lucene.Net.Analysis.Standard.Std34
zzReader.Dispose();
}
-
- /**
- * Resets the scanner to read from a new input stream.
- * Does not close the old reader.
- *
- * All internal variables are reset, the old input stream
- * <b>cannot</b> be reused (internal buffer is discarded and lost).
- * Lexical state is set to <tt>ZZ_INITIAL</tt>.
- *
- * Internal scan buffer is resized down to its initial length, if it has grown.
- *
- * @param reader the new input stream
- */
+ /// <summary>
+ /// Resets the scanner to read from a new input stream.
+ /// Does not close the old reader.
+ /// <para/>
+ /// All internal variables are reset, the old input stream
+ /// <b>cannot</b> be reused (internal buffer is discarded and lost).
+ /// Lexical state is set to <see cref="YYINITIAL"/>.
+ /// <para/>
+ /// Internal scan buffer is resized down to its initial length, if it has grown.
+ /// </summary>
+ /// <param name="reader">the new input stream </param>
public void YyReset(TextReader reader)
{
zzReader = reader;
@@ -887,75 +883,67 @@ namespace Lucene.Net.Analysis.Standard.Std34
}
- /**
- * Returns the current lexical state.
- */
+ /// <summary>
+ /// Returns the current lexical state.
+ /// </summary>
public int YyState
{
get { return zzLexicalState; }
}
-
- /**
- * Enters a new lexical state
- *
- * @param newState the new lexical state
- */
+ /// <summary>
+ /// Enters a new lexical state
+ /// </summary>
+ /// <param name="newState">the new lexical state</param>
public void YyBegin(int newState)
{
zzLexicalState = newState;
}
-
- /**
- * Returns the text matched by the current regular expression.
- */
+ /// <summary>
+ /// Returns the text matched by the current regular expression.
+ /// </summary>
public string YyText
{
get { return new string(zzBuffer, zzStartRead, zzMarkedPos - zzStartRead); }
}
-
- /**
- * Returns the character at position <tt>pos</tt> from the
- * matched text.
- *
- * It is equivalent to YyText().charAt(pos), but faster
- *
- * @param pos the position of the character to fetch.
- * A value from 0 to YyLength()-1.
- *
- * @return the character at position pos
- */
+ /// <summary>
+ /// Returns the character at position <paramref name="pos"/> from the
+ /// matched text.
+ /// <para/>
+ /// It is equivalent to YyText[pos], but faster
+ /// </summary>
+ /// <param name="pos">
+ /// the position of the character to fetch.
+ /// A value from 0 to YyLength-1.
+ /// </param>
+ /// <returns>the character at position pos</returns>
public char YyCharAt(int pos)
{
return zzBuffer[zzStartRead + pos];
}
- /**
- * Returns the length of the matched text region.
- */
+ /// <summary>
+ /// Returns the length of the matched text region.
+ /// </summary>
public int YyLength
{
get { return zzMarkedPos - zzStartRead; }
}
-
- /**
- * Reports an error that occured while scanning.
- *
- * In a wellformed scanner (no or only correct usage of
- * YyPushBack(int) and a match-all fallback rule) this method
- * will only be called with things that "Can't Possibly Happen".
- * If this method is called, something is seriously wrong
- * (e.g. a JFlex bug producing a faulty scanner etc.).
- *
- * Usual syntax/scanner level error handling should be done
- * in error fallback rules.
- *
- * @param errorCode the code of the errormessage to display
- */
+ /// <summary>
+ /// Reports an error that occured while scanning.
+ /// <para/>
+ /// In a wellformed scanner (no or only correct usage of
+ /// YyPushBack(int) and a match-all fallback rule) this method
+ /// will only be called with things that "Can't Possibly Happen".
+ /// If this method is called, something is seriously wrong
+ /// Usual syntax/scanner level error handling should be done
+ /// in error fallback rules.
+ /// </summary>
+ /// <param name="errorCode">the code of the errormessage to display</param>
private void ZzScanError(int errorCode)
{
string message;
@@ -971,15 +959,15 @@ namespace Lucene.Net.Analysis.Standard.Std34
throw new Exception(message);
}
-
- /**
- * Pushes the specified amount of characters back into the input stream.
- *
- * They will be read again by then next call of the scanning method
- *
- * @param number the number of characters to be read again.
- * This number must not be greater than YyLength()!
- */
+ /// <summary>
+ /// Pushes the specified amount of characters back into the input stream.
+ /// <para/>
+ /// They will be read again by then next call of the scanning method
+ /// </summary>
+ /// <param name="number">
+ /// the number of characters to be read again.
+ /// This number must not be greater than YyLength!
+ /// </param>
public void YyPushBack(int number)
{
if (number > YyLength)
@@ -988,14 +976,12 @@ namespace Lucene.Net.Analysis.Standard.Std34
zzMarkedPos -= number;
}
-
- /**
- * Resumes scanning until the next regular expression is matched,
- * the end of input is encountered or an I/O-Error occurs.
- *
- * @return the next token
- * @exception java.io.IOException if any I/O-Error occurs
- */
+ /// <summary>
+ /// Resumes scanning until the next regular expression is matched,
+ /// the end of input is encountered or an I/O-Error occurs.
+ /// </summary>
+ /// <returns>the next token</returns>
+ /// <exception cref="IOException">if any I/O-Error occurs</exception>
public int GetNextToken()
{
int zzInput;
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ab69b431/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/UAX29URLEmailTokenizerImpl34.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/UAX29URLEmailTokenizerImpl34.cs b/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/UAX29URLEmailTokenizerImpl34.cs
index c2066de..d774d6d 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/UAX29URLEmailTokenizerImpl34.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std34/UAX29URLEmailTokenizerImpl34.cs
@@ -32,26 +32,26 @@ namespace Lucene.Net.Analysis.Standard.Std34
[Obsolete("This class is only for exact backwards compatibility")]
public sealed class UAX29URLEmailTokenizerImpl34 : IStandardTokenizerInterface
{
- /** This character denotes the end of file */
+ /// <summary>This character denotes the end of file</summary>
public static readonly int YYEOF = -1;
- /** initial size of the lookahead buffer */
+ /// <summary>initial size of the lookahead buffer </summary>
private static readonly int ZZ_BUFFERSIZE = 4096;
- /** lexical states */
+ /// <summary>lexical states</summary>
public const int YYINITIAL = 0;
- /**
- * ZZ_LEXSTATE[l] is the state in the DFA for the lexical state l
- * ZZ_LEXSTATE[l+1] is the state in the DFA for the lexical state l
- * at the beginning of a line
- * l is of the form l = 2*k, k a non negative integer
- */
+ /// <summary>
+ /// ZZ_LEXSTATE[l] is the state in the DFA for the lexical state l
+ /// ZZ_LEXSTATE[l+1] is the state in the DFA for the lexical state l
+ /// at the beginning of a line
+ /// l is of the form l = 2*k, k a non negative integer
+ /// </summary>
private static readonly int[] ZZ_LEXSTATE = { 0, 0 };
- /**
- * Translates characters to character classes
- */
+ /// <summary>
+ /// Translates characters to character classes
+ /// </summary>
private static readonly string ZZ_CMAP_PACKED =
"\x0001\x009F\x0008\x009D\x0002\x009F\x0002\x009D\x0001\x009F\x0013\x009D\x0001\x00A0\x0001\x009C\x0001\x0097\x0001\x00A0" +
"\x0001\x0090\x0001\x008E\x0001\x0093\x0002\x0091\x0002\x00A0\x0001\x0092\x0001\x0082\x0001\x0067\x0001\x0096\x0001\x0083" +
@@ -195,14 +195,14 @@ namespace Lucene.Net.Analysis.Standard.Std34
"\x001A\x005A\x000B\x0000\x0038\x005D\x0002\x005B\x001F\x0066\x0003\x0000\x0006\x0066\x0002\x0000\x0006\x0066\x0002\x0000" +
"\x0006\x0066\x0002\x0000\x0003\x0066\x001C\x0000\x0003\x005B\x0004\x0000";
- /**
- * Translates characters to character classes
- */
+ /// <summary>
+ /// Translates characters to character classes
+ /// </summary>
private static readonly char[] ZZ_CMAP = ZzUnpackCMap(ZZ_CMAP_PACKED);
- /**
- * Translates DFA states to action switch labels.
- */
+ /// <summary>
+ /// Translates DFA states to action switch labels.
+ /// </summary>
private static readonly int[] ZZ_ACTION = ZzUnpackAction();
private const string ZZ_ACTION_PACKED_0 =
@@ -247,9 +247,9 @@ namespace Lucene.Net.Analysis.Standard.Std34
}
- /**
- * Translates a state to a row index in the transition table
- */
+ /// <summary>
+ /// Translates a state to a row index in the transition table
+ /// </summary>
private static readonly int[] ZZ_ROWMAP = ZzUnpackRowMap();
private const string ZZ_ROWMAP_PACKED_0 =
@@ -448,9 +448,9 @@ namespace Lucene.Net.Analysis.Standard.Std34
return j;
}
- /**
- * The transition table of the DFA
- */
+ /// <summary>
+ /// The transition table of the DFA
+ /// </summary>
private static readonly int[] ZZ_TRANS = ZzUnpackTrans();
private const string ZZ_TRANS_PACKED_0 =
@@ -3261,9 +3261,9 @@ namespace Lucene.Net.Analysis.Standard.Std34
"Error: pushback value was too large"
};
- /**
- * ZZ_ATTRIBUTE[aState] contains the attributes of state <code>aState</code>
- */
+ /// <summary>
+ /// ZZ_ATTRIBUTE[aState] contains the attributes of state <c>aState</c>
+ /// </summary>
private static readonly int[] ZZ_ATTRIBUTE = ZzUnpackAttribute();
private const string ZZ_ATTRIBUTE_PACKED_0 =
@@ -3304,73 +3304,77 @@ namespace Lucene.Net.Analysis.Standard.Std34
return j;
}
- /** the input device */
+ /// <summary>the input device</summary>
private TextReader zzReader;
- /** the current state of the DFA */
+ /// <summary>the current state of the DFA</summary>
private int zzState;
- /** the current lexical state */
+ /// <summary>the current lexical state</summary>
private int zzLexicalState = YYINITIAL;
- /** this buffer contains the current text to be matched and is
- the source of the YyText() string */
+ /// <summary>
+ /// this buffer contains the current text to be matched and is
+ /// the source of the YyText string
+ /// </summary>
private char[] zzBuffer = new char[ZZ_BUFFERSIZE];
- /** the textposition at the last accepting state */
+ /// <summary>the textposition at the last accepting state</summary>
private int zzMarkedPos;
- /** the current text position in the buffer */
+ /// <summary>the current text position in the buffer</summary>
private int zzCurrentPos;
- /** startRead marks the beginning of the YyText() string in the buffer */
+ /// <summary>startRead marks the beginning of the YyText string in the buffer</summary>
private int zzStartRead;
- /** endRead marks the last character in the buffer, that has been read
- from input */
+ /// <summary>
+ /// endRead marks the last character in the buffer, that has been read
+ /// from input
+ /// </summary>
private int zzEndRead;
- /** number of newlines encountered up to the start of the matched text */
+ /// <summary>number of newlines encountered up to the start of the matched text</summary>
private int yyline;
- /** the number of characters up to the start of the matched text */
+ /// <summary>the number of characters up to the start of the matched text</summary>
private int yychar;
#pragma warning disable 169, 414
- /**
- * the number of characters from the last newline up to the start of the
- * matched text
- */
+ /// <summary>
+ /// the number of characters from the last newline up to the start of the
+ /// matched text
+ /// </summary>
private int yycolumn;
- /**
- * zzAtBOL == true <=> the scanner is currently at the beginning of a line
- */
+ /// <summary>
+ /// zzAtBOL == true <=> the scanner is currently at the beginning of a line
+ /// </summary>
private bool zzAtBOL = true;
- /** zzAtEOF == true <=> the scanner is at the EOF */
+ /// <summary>zzAtEOF == true <=> the scanner is at the EOF</summary>
private bool zzAtEOF;
- /** denotes if the user-EOF-code has already been executed */
+ /// <summary>denotes if the user-EOF-code has already been executed</summary>
private bool zzEOFDone;
#pragma warning restore 169, 414
/* user code: */
- /** Alphanumeric sequences */
+ /// <summary>Alphanumeric sequences</summary>
public static readonly int WORD_TYPE = UAX29URLEmailTokenizer.ALPHANUM;
- /** Numbers */
+ /// <summary>Numbers</summary>
public static readonly int NUMERIC_TYPE = UAX29URLEmailTokenizer.NUM;
- /**
- * Chars in class \p{Line_Break = Complex_Context} are from South East Asian
- * scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept
- * together as as a single token rather than broken up, because the logic
- * required to break them at word boundaries is too complex for UAX#29.
- * <p>
- * See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
- */
+ /// <summary>
+ /// Chars in class \p{Line_Break = Complex_Context} are from South East Asian
+ /// scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept
+ /// together as as a single token rather than broken up, because the logic
+ /// required to break them at word boundaries is too complex for UAX#29.
+ /// <para/>
+ /// See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
+ /// </summary>
public static readonly int SOUTH_EAST_ASIAN_TYPE = UAX29URLEmailTokenizer.SOUTHEAST_ASIAN;
public static readonly int IDEOGRAPHIC_TYPE = UAX29URLEmailTokenizer.IDEOGRAPHIC;
@@ -3390,32 +3394,28 @@ namespace Lucene.Net.Analysis.Standard.Std34
get { return yychar; }
}
- /**
- * Fills CharTermAttribute with the current token text.
- */
+ /// <summary>
+ /// Fills ICharTermAttribute with the current token text.
+ /// </summary>
public void GetText(ICharTermAttribute t)
{
t.CopyBuffer(zzBuffer, zzStartRead, zzMarkedPos - zzStartRead);
}
-
- /**
- * Creates a new scanner
- *
- * @param in the TextReader to read input from.
- */
+ /// <summary>
+ /// Creates a new scanner
+ /// </summary>
+ /// <param name="in">the TextReader to read input from.</param>
public UAX29URLEmailTokenizerImpl34(TextReader @in)
{
this.zzReader = @in;
}
-
- /**
- * Unpacks the compressed character translation table.
- *
- * @param packed the packed character translation table
- * @return the unpacked character translation table
- */
+ /// <summary>
+ /// Unpacks the compressed character translation table.
+ /// </summary>
+ /// <param name="packed">the packed character translation table</param>
+ /// <returns>the unpacked character translation table</returns>
private static char[] ZzUnpackCMap(string packed)
{
char[] map = new char[0x10000];
@@ -3430,14 +3430,11 @@ namespace Lucene.Net.Analysis.Standard.Std34
return map;
}
-
- /**
- * Refills the input buffer.
- *
- * @return <code>false</code>, iff there was new input.
- *
- * @exception java.io.IOException if any I/O-Error occurs
- */
+ /// <summary>
+ /// Refills the input buffer.
+ /// </summary>
+ /// <returns><c>false</c>, iff there was new input.</returns>
+ /// <exception cref="IOException">if any I/O-Error occurs</exception>
private bool ZzRefill()
{
@@ -3493,9 +3490,9 @@ namespace Lucene.Net.Analysis.Standard.Std34
}
- /**
- * Closes the input stream.
- */
+ /// <summary>
+ /// Disposes the input stream.
+ /// </summary>
public void YyClose()
{
zzAtEOF = true; /* indicate end of file */
@@ -3507,19 +3504,17 @@ namespace Lucene.Net.Analysis.Standard.Std34
}
}
-
- /**
- * Resets the scanner to read from a new input stream.
- * Does not close the old reader.
- *
- * All internal variables are reset, the old input stream
- * <b>cannot</b> be reused (internal buffer is discarded and lost).
- * Lexical state is set to <tt>ZZ_INITIAL</tt>.
- *
- * Internal scan buffer is resized down to its initial length, if it has grown.
- *
- * @param reader the new input stream
- */
+ /// <summary>
+ /// Resets the scanner to read from a new input stream.
+ /// Does not close the old reader.
+ /// <para/>
+ /// All internal variables are reset, the old input stream
+ /// <b>cannot</b> be reused (internal buffer is discarded and lost).
+ /// Lexical state is set to <see cref="YYINITIAL"/>.
+ /// <para/>
+ /// Internal scan buffer is resized down to its initial length, if it has grown.
+ /// </summary>
+ /// <param name="reader">the new input stream </param>
public void YyReset(TextReader reader)
{
zzReader = reader;
@@ -3535,75 +3530,69 @@ namespace Lucene.Net.Analysis.Standard.Std34
}
- /**
- * Returns the current lexical state.
- */
+ /// <summary>
+ /// Returns the current lexical state.
+ /// </summary>
public int YyState
{
get { return zzLexicalState; }
}
-
- /**
- * Enters a new lexical state
- *
- * @param newState the new lexical state
- */
+ /// <summary>
+ /// Enters a new lexical state
+ /// </summary>
+ /// <param name="newState">the new lexical state</param>
public void YyBegin(int newState)
{
zzLexicalState = newState;
}
-
- /**
- * Returns the text matched by the current regular expression.
- */
+ /// <summary>
+ /// Returns the text matched by the current regular expression.
+ /// </summary>
public string YyText
{
get { return new string(zzBuffer, zzStartRead, zzMarkedPos - zzStartRead); }
}
-
- /**
- * Returns the character at position <tt>pos</tt> from the
- * matched text.
- *
- * It is equivalent to YyText().charAt(pos), but faster
- *
- * @param pos the position of the character to fetch.
- * A value from 0 to YyLength()-1.
- *
- * @return the character at position pos
- */
+ /// <summary>
+ /// Returns the character at position <paramref name="pos"/> from the
+ /// matched text.
+ /// <para/>
+ /// It is equivalent to YyText[pos], but faster
+ /// </summary>
+ /// <param name="pos">
+ /// the position of the character to fetch.
+ /// A value from 0 to YyLength-1.
+ /// </param>
+ /// <returns>the character at position pos</returns>
public char YyCharAt(int pos)
{
return zzBuffer[zzStartRead + pos];
}
- /**
- * Returns the length of the matched text region.
- */
+ /// <summary>
+ /// Returns the length of the matched text region.
+ /// </summary>
public int YyLength
{
get { return zzMarkedPos - zzStartRead; }
}
-
- /**
- * Reports an error that occured while scanning.
- *
- * In a wellformed scanner (no or only correct usage of
- * YyPushBack(int) and a match-all fallback rule) this method
- * will only be called with things that "Can't Possibly Happen".
- * If this method is called, something is seriously wrong
- * (e.g. a JFlex bug producing a faulty scanner etc.).
- *
- * Usual syntax/scanner level error handling should be done
- * in error fallback rules.
- *
- * @param errorCode the code of the errormessage to display
- */
+ /// <summary>
+ /// Reports an error that occured while scanning.
+ /// <para/>
+ /// In a wellformed scanner (no or only correct usage of
+ /// YyPushBack(int) and a match-all fallback rule) this method
+ /// will only be called with things that "Can't Possibly Happen".
+ /// If this method is called, something is seriously wrong
+ /// (e.g. a JFlex bug producing a faulty scanner etc.).
+ /// <para/>
+ /// Usual syntax/scanner level error handling should be done
+ /// in error fallback rules.
+ /// </summary>
+ /// <param name="errorCode">the code of the errormessage to display</param>
private void ZzScanError(int errorCode)
{
string message;
@@ -3619,15 +3608,15 @@ namespace Lucene.Net.Analysis.Standard.Std34
throw new Exception(message);
}
-
- /**
- * Pushes the specified amount of characters back into the input stream.
- *
- * They will be read again by then next call of the scanning method
- *
- * @param number the number of characters to be read again.
- * This number must not be greater than YyLength()!
- */
+ /// <summary>
+ /// Pushes the specified amount of characters back into the input stream.
+ /// <para/>
+ /// They will be read again by then next call of the scanning method
+ /// </summary>
+ /// <param name="number">
+ /// the number of characters to be read again.
+ /// This number must not be greater than YyLength!
+ /// </param>
public void YyPushBack(int number)
{
if (number > YyLength)
@@ -3636,14 +3625,12 @@ namespace Lucene.Net.Analysis.Standard.Std34
zzMarkedPos -= number;
}
-
- /**
- * Resumes scanning until the next regular expression is matched,
- * the end of input is encountered or an I/O-Error occurs.
- *
- * @return the next token
- * @exception java.io.IOException if any I/O-Error occurs
- */
+ /// <summary>
+ /// Resumes scanning until the next regular expression is matched,
+ /// the end of input is encountered or an I/O-Error occurs.
+ /// </summary>
+ /// <returns>the next token</returns>
+ /// <exception cref="IOException">if any I/O-Error occurs</exception>
public int GetNextToken()
{
int zzInput;
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ab69b431/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std36/UAX29URLEmailTokenizerImpl36.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std36/UAX29URLEmailTokenizerImpl36.cs b/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std36/UAX29URLEmailTokenizerImpl36.cs
index 9d8f68d..afa04ff 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std36/UAX29URLEmailTokenizerImpl36.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std36/UAX29URLEmailTokenizerImpl36.cs
@@ -28,26 +28,26 @@ namespace Lucene.Net.Analysis.Standard.Std36
[Obsolete("This class is only for exact backwards compatibility")]
public sealed class UAX29URLEmailTokenizerImpl36 : IStandardTokenizerInterface
{
- /** This character denotes the end of file */
+ /// <summary>This character denotes the end of file</summary>
public static readonly int YYEOF = -1;
- /** initial size of the lookahead buffer */
+ /// <summary>initial size of the lookahead buffer</summary>
private static readonly int ZZ_BUFFERSIZE = 4096;
- /** lexical states */
+ /// <summary>lexical states</summary>
public const int YYINITIAL = 0;
- /**
- * ZZ_LEXSTATE[l] is the state in the DFA for the lexical state l
- * ZZ_LEXSTATE[l+1] is the state in the DFA for the lexical state l
- * at the beginning of a line
- * l is of the form l = 2*k, k a non negative integer
- */
+ /// <summary>
+ /// ZZ_LEXSTATE[l] is the state in the DFA for the lexical state l
+ /// ZZ_LEXSTATE[l+1] is the state in the DFA for the lexical state l
+ /// at the beginning of a line
+ /// l is of the form l = 2*k, k a non negative integer
+ /// </summary>
private static readonly int[] ZZ_LEXSTATE = { 0, 0 };
- /**
- * Translates characters to character classes
- */
+ /// <summary>
+ /// Translates characters to character classes
+ /// </summary>
private const string ZZ_CMAP_PACKED =
"\x0001\x009F\x0008\x009D\x0002\x009F\x0002\x009D\x0001\x009F\x0013\x009D\x0001\x00A0\x0001\x009C\x0001\x0097\x0001\x00A0" +
"\x0001\x0090\x0001\x008E\x0001\x0093\x0002\x0091\x0002\x00A0\x0001\x0092\x0001\x0082\x0001\x0067\x0001\x0096\x0001\x0083" +
@@ -191,14 +191,14 @@ namespace Lucene.Net.Analysis.Standard.Std36
"\x001A\x005A\x000B\x0000\x0038\x005D\x0002\x005B\x001F\x0066\x0003\x0000\x0006\x0066\x0002\x0000\x0006\x0066\x0002\x0000" +
"\x0006\x0066\x0002\x0000\x0003\x0066\x001C\x0000\x0003\x005B\x0004\x0000";
- /**
- * Translates characters to character classes
- */
+ /// <summary>
+ /// Translates characters to character classes
+ /// </summary>
private static readonly char[] ZZ_CMAP = ZzUnpackCMap(ZZ_CMAP_PACKED);
- /**
- * Translates DFA states to action switch labels.
- */
+ /// <summary>
+ /// Translates DFA states to action switch labels.
+ /// </summary>
private static readonly int[] ZZ_ACTION = ZzUnpackAction();
private const string ZZ_ACTION_PACKED_0 =
@@ -245,9 +245,9 @@ namespace Lucene.Net.Analysis.Standard.Std36
}
- /**
- * Translates a state to a row index in the transition table
- */
+ /// <summary>
+ /// Translates a state to a row index in the transition table
+ /// </summary>
private static readonly int[] ZZ_ROWMAP = ZzUnpackRowMap();
private const string ZZ_ROWMAP_PACKED_0 =
@@ -487,9 +487,9 @@ namespace Lucene.Net.Analysis.Standard.Std36
return j;
}
- /**
- * The transition table of the DFA
- */
+ /// <summary>
+ /// The transition table of the DFA
+ /// </summary>
private static readonly int[] ZZ_TRANS = ZzUnpackTrans();
private const string ZZ_TRANS_PACKED_0 =
@@ -3694,9 +3694,9 @@ namespace Lucene.Net.Analysis.Standard.Std36
"Error: pushback value was too large"
};
- /**
- * ZZ_ATTRIBUTE[aState] contains the attributes of state <code>aState</code>
- */
+ /// <summary>
+ /// ZZ_ATTRIBUTE[aState] contains the attributes of state <c>aState</c>
+ /// </summary>
private static readonly int[] ZZ_ATTRIBUTE = ZzUnpackAttribute();
private const string ZZ_ATTRIBUTE_PACKED_0 =
@@ -3739,73 +3739,77 @@ namespace Lucene.Net.Analysis.Standard.Std36
return j;
}
- /** the input device */
+ /// <summary>the input device</summary>
private TextReader zzReader;
- /** the current state of the DFA */
+ /// <summary>the current state of the DFA</summary>
private int zzState;
- /** the current lexical state */
+ /// <summary>the current lexical state</summary>
private int zzLexicalState = YYINITIAL;
- /** this buffer contains the current text to be matched and is
- the source of the YyText() string */
+ /// <summary>
+ /// this buffer contains the current text to be matched and is
+ /// the source of the YyText string
+ /// </summary>
private char[] zzBuffer = new char[ZZ_BUFFERSIZE];
- /** the textposition at the last accepting state */
+ /// <summary>the textposition at the last accepting state</summary>
private int zzMarkedPos;
- /** the current text position in the buffer */
+ /// <summary>the current text position in the buffer</summary>
private int zzCurrentPos;
- /** startRead marks the beginning of the YyText() string in the buffer */
+ /// <summary>startRead marks the beginning of the YyText string in the buffer</summary>
private int zzStartRead;
- /** endRead marks the last character in the buffer, that has been read
- from input */
+ /// <summary>
+ /// endRead marks the last character in the buffer, that has been read
+ /// from input
+ /// </summary>
private int zzEndRead;
- /** number of newlines encountered up to the start of the matched text */
+ /// <summary>number of newlines encountered up to the start of the matched text</summary>
private int yyline;
- /** the number of characters up to the start of the matched text */
+ /// <summary>the number of characters up to the start of the matched text</summary>
private int yychar;
#pragma warning disable 169, 414
- /**
- * the number of characters from the last newline up to the start of the
- * matched text
- */
+ /// <summary>
+ /// the number of characters from the last newline up to the start of the
+ /// matched text
+ /// </summary>
private int yycolumn;
- /**
- * zzAtBOL == true <=> the scanner is currently at the beginning of a line
- */
+ /// <summary>
+ /// zzAtBOL == true <=> the scanner is currently at the beginning of a line
+ /// </summary>
private bool zzAtBOL = true;
- /** zzAtEOF == true <=> the scanner is at the EOF */
+ /// <summary>zzAtEOF == true <=> the scanner is at the EOF</summary>
private bool zzAtEOF;
- /** denotes if the user-EOF-code has already been executed */
+ /// <summary>denotes if the user-EOF-code has already been executed</summary>
private bool zzEOFDone;
#pragma warning restore 169, 414
/* user code: */
- /** Alphanumeric sequences */
+ /// <summary>Alphanumeric sequences</summary>
public static readonly int WORD_TYPE = UAX29URLEmailTokenizer.ALPHANUM;
- /** Numbers */
+ /// <summary>Numbers</summary>
public static readonly int NUMERIC_TYPE = UAX29URLEmailTokenizer.NUM;
- /**
- * Chars in class \p{Line_Break = Complex_Context} are from South East Asian
- * scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept
- * together as as a single token rather than broken up, because the logic
- * required to break them at word boundaries is too complex for UAX#29.
- * <p>
- * See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
- */
+ /// <summary>
+ /// Chars in class \p{Line_Break = Complex_Context} are from South East Asian
+ /// scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept
+ /// together as as a single token rather than broken up, because the logic
+ /// required to break them at word boundaries is too complex for UAX#29.
+ /// <para/>
+ /// See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
+ /// </summary>
public static readonly int SOUTH_EAST_ASIAN_TYPE = UAX29URLEmailTokenizer.SOUTHEAST_ASIAN;
public static readonly int IDEOGRAPHIC_TYPE = UAX29URLEmailTokenizer.IDEOGRAPHIC;
@@ -3825,32 +3829,28 @@ namespace Lucene.Net.Analysis.Standard.Std36
get { return yychar; }
}
- /**
- * Fills CharTermAttribute with the current token text.
- */
+ /// <summary>
+ /// Fills ICharTermAttribute with the current token text.
+ /// </summary>
public void GetText(ICharTermAttribute t)
{
t.CopyBuffer(zzBuffer, zzStartRead, zzMarkedPos - zzStartRead);
}
-
- /**
- * Creates a new scanner
- *
- * @param in the TextReader to read input from.
- */
+ /// <summary>
+ /// Creates a new scanner
+ /// </summary>
+ /// <param name="in">the TextReader to read input from.</param>
public UAX29URLEmailTokenizerImpl36(TextReader @in)
{
this.zzReader = @in;
}
-
- /**
- * Unpacks the compressed character translation table.
- *
- * @param packed the packed character translation table
- * @return the unpacked character translation table
- */
+ /// <summary>
+ /// Unpacks the compressed character translation table.
+ /// </summary>
+ /// <param name="packed">the packed character translation table</param>
+ /// <returns>the unpacked character translation table</returns>
private static char[] ZzUnpackCMap(string packed)
{
char[] map = new char[0x10000];
@@ -3865,14 +3865,11 @@ namespace Lucene.Net.Analysis.Standard.Std36
return map;
}
-
- /**
- * Refills the input buffer.
- *
- * @return <code>false</code>, iff there was new input.
- *
- * @exception java.io.IOException if any I/O-Error occurs
- */
+ /// <summary>
+ /// Refills the input buffer.
+ /// </summary>
+ /// <returns><c>false</c>, iff there was new input.</returns>
+ /// <exception cref="IOException">if any I/O-Error occurs</exception>
private bool ZzRefill()
{
@@ -3928,9 +3925,9 @@ namespace Lucene.Net.Analysis.Standard.Std36
}
- /**
- * Closes the input stream.
- */
+ /// <summary>
+ /// Disposes the input stream.
+ /// </summary>
public void YyClose()
{
zzAtEOF = true; /* indicate end of file */
@@ -3942,19 +3939,17 @@ namespace Lucene.Net.Analysis.Standard.Std36
}
}
-
- /**
- * Resets the scanner to read from a new input stream.
- * Does not close the old reader.
- *
- * All internal variables are reset, the old input stream
- * <b>cannot</b> be reused (internal buffer is discarded and lost).
- * Lexical state is set to <tt>ZZ_INITIAL</tt>.
- *
- * Internal scan buffer is resized down to its initial length, if it has grown.
- *
- * @param reader the new input stream
- */
+ /// <summary>
+ /// Resets the scanner to read from a new input stream.
+ /// Does not close the old reader.
+ /// <para/>
+ /// All internal variables are reset, the old input stream
+ /// <b>cannot</b> be reused (internal buffer is discarded and lost).
+ /// Lexical state is set to <see cref="YYINITIAL"/>.
+ /// <para/>
+ /// Internal scan buffer is resized down to its initial length, if it has grown.
+ /// </summary>
+ /// <param name="reader">the new input stream </param>
public void YyReset(TextReader reader)
{
zzReader = reader;
@@ -3970,75 +3965,71 @@ namespace Lucene.Net.Analysis.Standard.Std36
}
- /**
- * Returns the current lexical state.
- */
+ /// <summary>
+ /// Returns the current lexical state.
+ /// </summary>
public int YyState
{
get { return zzLexicalState; }
}
-
- /**
- * Enters a new lexical state
- *
- * @param newState the new lexical state
- */
+ /// <summary>
+ /// Enters a new lexical state
+ /// </summary>
+ /// <param name="newState">the new lexical state</param>
public void YyBegin(int newState)
{
zzLexicalState = newState;
}
-
- /**
- * Returns the text matched by the current regular expression.
- */
+ /// <summary>
+ /// Returns the text matched by the current regular expression.
+ /// </summary>
public string YyText
{
get { return new string(zzBuffer, zzStartRead, zzMarkedPos - zzStartRead); }
}
- /**
- * Returns the character at position <tt>pos</tt> from the
- * matched text.
- *
- * It is equivalent to YyText().charAt(pos), but faster
- *
- * @param pos the position of the character to fetch.
- * A value from 0 to YyLength()-1.
- *
- * @return the character at position pos
- */
+ /// <summary>
+ /// Returns the character at position <paramref name="pos"/> from the
+ /// matched text.
+ /// <para/>
+ /// It is equivalent to YyText[pos], but faster
+ /// </summary>
+ /// <param name="pos">
+ /// the position of the character to fetch.
+ /// A value from 0 to YyLength-1.
+ /// </param>
+ /// <returns>the character at position pos</returns>
public char YyCharAt(int pos)
{
return zzBuffer[zzStartRead + pos];
}
- /**
- * Returns the length of the matched text region.
- */
+ /// <summary>
+ /// Returns the length of the matched text region.
+ /// </summary>
public int YyLength
{
get { return zzMarkedPos - zzStartRead; }
}
- /**
- * Reports an error that occured while scanning.
- *
- * In a wellformed scanner (no or only correct usage of
- * YyPushBack(int) and a match-all fallback rule) this method
- * will only be called with things that "Can't Possibly Happen".
- * If this method is called, something is seriously wrong
- * (e.g. a JFlex bug producing a faulty scanner etc.).
- *
- * Usual syntax/scanner level error handling should be done
- * in error fallback rules.
- *
- * @param errorCode the code of the errormessage to display
- */
+ /// <summary>
+ /// Reports an error that occured while scanning.
+ /// <para/>
+ /// In a wellformed scanner (no or only correct usage of
+ /// YyPushBack(int) and a match-all fallback rule) this method
+ /// will only be called with things that "Can't Possibly Happen".
+ /// If this method is called, something is seriously wrong
+ /// (e.g. a JFlex bug producing a faulty scanner etc.).
+ /// <para/>
+ /// Usual syntax/scanner level error handling should be done
+ /// in error fallback rules.
+ /// </summary>
+ /// <param name="errorCode">the code of the errormessage to display</param>
private void ZzScanError(int errorCode)
{
string message;
@@ -4055,14 +4046,15 @@ namespace Lucene.Net.Analysis.Standard.Std36
}
- /**
- * Pushes the specified amount of characters back into the input stream.
- *
- * They will be read again by then next call of the scanning method
- *
- * @param number the number of characters to be read again.
- * This number must not be greater than YyLength()!
- */
+ /// <summary>
+ /// Pushes the specified amount of characters back into the input stream.
+ /// <para/>
+ /// They will be read again by then next call of the scanning method
+ /// </summary>
+ /// <param name="number">
+ /// the number of characters to be read again.
+ /// This number must not be greater than YyLength!
+ /// </param>
public void YyPushBack(int number)
{
if (number > YyLength)
@@ -4072,13 +4064,12 @@ namespace Lucene.Net.Analysis.Standard.Std36
}
- /**
- * Resumes scanning until the next regular expression is matched,
- * the end of input is encountered or an I/O-Error occurs.
- *
- * @return the next token
- * @exception java.io.IOException if any I/O-Error occurs
- */
+ /// <summary>
+ /// Resumes scanning until the next regular expression is matched,
+ /// the end of input is encountered or an I/O-Error occurs.
+ /// </summary>
+ /// <returns>the next token</returns>
+ /// <exception cref="IOException">if any I/O-Error occurs</exception>
public int GetNextToken()
{
int zzInput;
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/ab69b431/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std40/StandardTokenizerImpl40.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std40/StandardTokenizerImpl40.cs b/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std40/StandardTokenizerImpl40.cs
index c0be18d..59bd49d 100644
--- a/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std40/StandardTokenizerImpl40.cs
+++ b/src/Lucene.Net.Analysis.Common/Analysis/Standard/Std40/StandardTokenizerImpl40.cs
@@ -29,26 +29,26 @@ namespace Lucene.Net.Analysis.Standard.Std40
[Obsolete("This class is only for exact backwards compatibility")]
public sealed class StandardTokenizerImpl40 : IStandardTokenizerInterface
{
- /** This character denotes the end of file */
+ /// <summary>This character denotes the end of file</summary>
public static readonly int YYEOF = -1;
- /** initial size of the lookahead buffer */
+ /// <summary>initial size of the lookahead buffer</summary>
private static readonly int ZZ_BUFFERSIZE = 4096;
- /** lexical states */
+ /// <summary>lexical states</summary>
public const int YYINITIAL = 0;
- /**
- * ZZ_LEXSTATE[l] is the state in the DFA for the lexical state l
- * ZZ_LEXSTATE[l+1] is the state in the DFA for the lexical state l
- * at the beginning of a line
- * l is of the form l = 2*k, k a non negative integer
- */
+ /// <summary>
+ /// ZZ_LEXSTATE[l] is the state in the DFA for the lexical state l
+ /// ZZ_LEXSTATE[l+1] is the state in the DFA for the lexical state l
+ /// at the beginning of a line
+ /// l is of the form l = 2*k, k a non negative integer
+ /// </summary>
private static readonly int[] ZZ_LEXSTATE = { 0, 0 };
- /**
- * Translates characters to character classes
- */
+ /// <summary>
+ /// Translates characters to character classes
+ /// </summary>
private const string ZZ_CMAP_PACKED =
"\x0027\x0000\x0001\x0082\x0004\x0000\x0001\x0081\x0001\x0000\x0001\x0082\x0001\x0000\x000A\x007E\x0001\x0080\x0001\x0081" +
"\x0005\x0000\x001A\x007C\x0004\x0000\x0001\x0083\x0001\x0000\x001A\x007C\x002F\x0000\x0001\x007C\x0002\x0000\x0001\x007D" +
@@ -194,14 +194,14 @@ namespace Lucene.Net.Analysis.Standard.Std40
"\x0038\x007F\x0002\x007D\x001F\x0088\x0003\x0000\x0006\x0088\x0002\x0000\x0006\x0088\x0002\x0000\x0006\x0088\x0002\x0000" +
"\x0003\x0088\x001C\x0000\x0003\x007D\x0004\x0000";
- /**
- * Translates characters to character classes
- */
+ /// <summary>
+ /// Translates characters to character classes
+ /// </summary>
private static readonly char[] ZZ_CMAP = ZzUnpackCMap(ZZ_CMAP_PACKED);
- /**
- * Translates DFA states to action switch labels.
- */
+ /// <summary>
+ /// Translates DFA states to action switch labels.
+ /// </summary>
private static readonly int[] ZZ_ACTION = ZzUnpackAction();
private const string ZZ_ACTION_PACKED_0 =
@@ -232,9 +232,9 @@ namespace Lucene.Net.Analysis.Standard.Std40
}
- /**
- * Translates a state to a row index in the transition table
- */
+ /// <summary>
+ /// Translates a state to a row index in the transition table
+ /// </summary>
private static readonly int[] ZZ_ROWMAP = ZzUnpackRowMap();
private const string ZZ_ROWMAP_PACKED_0 =
@@ -280,9 +280,9 @@ namespace Lucene.Net.Analysis.Standard.Std40
return j;
}
- /**
- * The transition table of the DFA
- */
+ /// <summary>
+ /// The transition table of the DFA
+ /// </summary>
private static readonly int[] ZZ_TRANS = ZzUnpackTrans();
private const string ZZ_TRANS_PACKED_0 =
@@ -738,9 +738,9 @@ namespace Lucene.Net.Analysis.Standard.Std40
"Error: pushback value was too large"
};
- /**
- * ZZ_ATTRIBUTE[aState] contains the attributes of state <code>aState</code>
- */
+ /// <summary>
+ /// ZZ_ATTRIBUTE[aState] contains the attributes of state <c>aState</c>
+ /// </summary>
private static readonly int[] ZZ_ATTRIBUTE = ZzUnpackAttribute();
private const string ZZ_ATTRIBUTE_PACKED_0 =
@@ -769,73 +769,77 @@ namespace Lucene.Net.Analysis.Standard.Std40
return j;
}
- /** the input device */
+ /// <summary>the input device</summary>
private TextReader zzReader;
- /** the current state of the DFA */
+ /// <summary>the current state of the DFA</summary>
private int zzState;
- /** the current lexical state */
+ /// <summary>the current lexical state</summary>
private int zzLexicalState = YYINITIAL;
- /** this buffer contains the current text to be matched and is
- the source of the YyText() string */
+ /// <summary>
+ /// this buffer contains the current text to be matched and is
+ /// the source of the YyText string
+ /// </summary>
private char[] zzBuffer = new char[ZZ_BUFFERSIZE];
- /** the textposition at the last accepting state */
+ /// <summary>the textposition at the last accepting state</summary>
private int zzMarkedPos;
- /** the current text position in the buffer */
+ /// <summary>the current text position in the buffer</summary>
private int zzCurrentPos;
- /** startRead marks the beginning of the YyText() string in the buffer */
+ /// <summary>startRead marks the beginning of the YyText string in the buffer</summary>
private int zzStartRead;
- /** endRead marks the last character in the buffer, that has been read
- from input */
+ /// <summary>
+ /// endRead marks the last character in the buffer, that has been read
+ /// from input
+ /// </summary>
private int zzEndRead;
- /** number of newlines encountered up to the start of the matched text */
+ /// <summary>number of newlines encountered up to the start of the matched text</summary>
private int yyline;
- /** the number of characters up to the start of the matched text */
+ /// <summary>the number of characters up to the start of the matched text</summary>
private int yyChar;
#pragma warning disable 169, 414
- /**
- * the number of characters from the last newline up to the start of the
- * matched text
- */
+ /// <summary>
+ /// the number of characters from the last newline up to the start of the
+ /// matched text
+ /// </summary>
private int yycolumn;
- /**
- * zzAtBOL == true <=> the scanner is currently at the beginning of a line
- */
+ /// <summary>
+ /// zzAtBOL == true <=> the scanner is currently at the beginning of a line
+ /// </summary>
private bool zzAtBOL = true;
- /** zzAtEOF == true <=> the scanner is at the EOF */
+ /// <summary>zzAtEOF == true <=> the scanner is at the EOF</summary>
private bool zzAtEOF;
- /** denotes if the user-EOF-code has already been executed */
+ /// <summary>denotes if the user-EOF-code has already been executed</summary>
private bool zzEOFDone;
#pragma warning restore 169, 414
/* user code: */
- /** Alphanumeric sequences */
+ /// <summary>Alphanumeric sequences</summary>
public static readonly int WORD_TYPE = StandardTokenizer.ALPHANUM;
- /** Numbers */
+ /// <summary>Numbers</summary>
public static readonly int NUMERIC_TYPE = StandardTokenizer.NUM;
- /**
- * Chars in class \p{Line_Break = Complex_Context} are from South East Asian
- * scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept
- * together as as a single token rather than broken up, because the logic
- * required to break them at word boundaries is too complex for UAX#29.
- * <p>
- * See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
- */
+ /// <summary>
+ /// Chars in class \p{Line_Break = Complex_Context} are from South East Asian
+ /// scripts (Thai, Lao, Myanmar, Khmer, etc.). Sequences of these are kept
+ /// together as as a single token rather than broken up, because the logic
+ /// required to break them at word boundaries is too complex for UAX#29.
+ /// <para/>
+ /// See Unicode Line Breaking Algorithm: http://www.unicode.org/reports/tr14/#SA
+ /// </summary>
public static readonly int SOUTH_EAST_ASIAN_TYPE = StandardTokenizer.SOUTHEAST_ASIAN;
public static readonly int IDEOGRAPHIC_TYPE = StandardTokenizer.IDEOGRAPHIC;
@@ -851,32 +855,30 @@ namespace Lucene.Net.Analysis.Standard.Std40
get { return yyChar; }
}
- /**
- * Fills CharTermAttribute with the current token text.
- */
+ /// <summary>
+ /// Fills ICharTermAttribute with the current token text.
+ /// </summary>
public void GetText(ICharTermAttribute t)
{
t.CopyBuffer(zzBuffer, zzStartRead, zzMarkedPos - zzStartRead);
}
- /**
- * Creates a new scanner
- *
- * @param in the TextReader to read input from.
- */
+ /// <summary>
+ /// Creates a new scanner
+ /// </summary>
+ /// <param name="in">the TextReader to read input from.</param>
public StandardTokenizerImpl40(TextReader @in)
{
this.zzReader = @in;
}
- /**
- * Unpacks the compressed character translation table.
- *
- * @param packed the packed character translation table
- * @return the unpacked character translation table
- */
+ /// <summary>
+ /// Unpacks the compressed character translation table.
+ /// </summary>
+ /// <param name="packed">the packed character translation table</param>
+ /// <returns>the unpacked character translation table</returns>
private static char[] ZzUnpackCMap(string packed)
{
char[] map = new char[0x10000];
@@ -892,13 +894,11 @@ namespace Lucene.Net.Analysis.Standard.Std40
}
- /**
- * Refills the input buffer.
- *
- * @return <code>false</code>, iff there was new input.
- *
- * @exception java.io.IOException if any I/O-Error occurs
- */
+ /// <summary>
+ /// Refills the input buffer.
+ /// </summary>
+ /// <returns><c>false</c>, iff there was new input.</returns>
+ /// <exception cref="IOException">if any I/O-Error occurs</exception>
private bool ZzRefill()
{
@@ -954,9 +954,9 @@ namespace Lucene.Net.Analysis.Standard.Std40
}
- /**
- * Closes the input stream.
- */
+ /// <summary>
+ /// Disposes the input stream.
+ /// </summary>
public void YyClose()
{
zzAtEOF = true; /* indicate end of file */
@@ -967,18 +967,17 @@ namespace Lucene.Net.Analysis.Standard.Std40
}
- /**
- * Resets the scanner to read from a new input stream.
- * Does not close the old reader.
- *
- * All internal variables are reset, the old input stream
- * <b>cannot</b> be reused (internal buffer is discarded and lost).
- * Lexical state is set to <tt>ZZ_INITIAL</tt>.
- *
- * Internal scan buffer is resized down to its initial length, if it has grown.
- *
- * @param reader the new input stream
- */
+ /// <summary>
+ /// Resets the scanner to read from a new input stream.
+ /// Does not close the old reader.
+ /// <para/>
+ /// All internal variables are reset, the old input stream
+ /// <b>cannot</b> be reused (internal buffer is discarded and lost).
+ /// Lexical state is set to <see cref="YYINITIAL"/>.
+ /// <para/>
+ /// Internal scan buffer is resized down to its initial length, if it has grown.
+ /// </summary>
+ /// <param name="reader">the new input stream </param>
public void YyReset(TextReader reader)
{
zzReader = reader;
@@ -994,75 +993,73 @@ namespace Lucene.Net.Analysis.Standard.Std40
}
- /**
- * Returns the current lexical state.
- */
+ /// <summary>
+ /// Returns the current lexical state.
+ /// </summary>
public int YyState
{
get { return zzLexicalState; }
}
- /**
- * Enters a new lexical state
- *
- * @param newState the new lexical state
- */
+ /// <summary>
+ /// Enters a new lexical state
+ /// </summary>
+ /// <param name="newState">the new lexical state</param>
public void YyBegin(int newState)
{
zzLexicalState = newState;
}
- /**
- * Returns the text matched by the current regular expression.
- */
+ /// <summary>
+ /// Returns the text matched by the current regular expression.
+ /// </summary>
public string YyText
{
get { return new string(zzBuffer, zzStartRead, zzMarkedPos - zzStartRead); }
}
- /**
- * Returns the character at position <tt>pos</tt> from the
- * matched text.
- *
- * It is equivalent to YyText().charAt(pos), but faster
- *
- * @param pos the position of the character to fetch.
- * A value from 0 to YyLength()-1.
- *
- * @return the character at position pos
- */
+ /// <summary>
+ /// Returns the character at position <paramref name="pos"/> from the
+ /// matched text.
+ /// <para/>
+ /// It is equivalent to YyText[pos], but faster
+ /// </summary>
+ /// <param name="pos">
+ /// the position of the character to fetch.
+ /// A value from 0 to YyLength-1.
+ /// </param>
+ /// <returns>the character at position pos</returns>
public char YyCharAt(int pos)
{
return zzBuffer[zzStartRead + pos];
}
- /**
- * Returns the length of the matched text region.
- */
+ /// <summary>
+ /// Returns the length of the matched text region.
+ /// </summary>
public int YyLength
{
get { return zzMarkedPos - zzStartRead; }
}
- /**
- * Reports an error that occured while scanning.
- *
- * In a wellformed scanner (no or only correct usage of
- * YyPushBack(int) and a match-all fallback rule) this method
- * will only be called with things that "Can't Possibly Happen".
- * If this method is called, something is seriously wrong
- * (e.g. a JFlex bug producing a faulty scanner etc.).
- *
- * Usual syntax/scanner level error handling should be done
- * in error fallback rules.
- *
- * @param errorCode the code of the errormessage to display
- */
+ /// <summary>
+ /// Reports an error that occured while scanning.
+ /// <para/>
+ /// In a wellformed scanner (no or only correct usage of
+ /// YyPushBack(int) and a match-all fallback rule) this method
+ /// will only be called with things that "Can't Possibly Happen".
+ /// If this method is called, something is seriously wrong
+ /// (e.g. a JFlex bug producing a faulty scanner etc.).
+ /// <para/>
+ /// Usual syntax/scanner level error handling should be done
+ /// in error fallback rules.
+ /// </summary>
+ /// <param name="errorCode">the code of the errormessage to display</param>
private void ZzScanError(int errorCode)
{
string message;
@@ -1079,14 +1076,15 @@ namespace Lucene.Net.Analysis.Standard.Std40
}
- /**
- * Pushes the specified amount of characters back into the input stream.
- *
- * They will be read again by then next call of the scanning method
- *
- * @param number the number of characters to be read again.
- * This number must not be greater than YyLength()!
- */
+ /// <summary>
+ /// Pushes the specified amount of characters back into the input stream.
+ /// <para/>
+ /// They will be read again by then next call of the scanning method
+ /// </summary>
+ /// <param name="number">
+ /// the number of characters to be read again.
+ /// This number must not be greater than YyLength!
+ /// </param>
public void YyPushBack(int number)
{
if (number > YyLength)
@@ -1096,13 +1094,12 @@ namespace Lucene.Net.Analysis.Standard.Std40
}
- /**
- * Resumes scanning until the next regular expression is matched,
- * the end of input is encountered or an I/O-Error occurs.
- *
- * @return the next token
- * @exception java.io.IOException if any I/O-Error occurs
- */
+ /// <summary>
+ /// Resumes scanning until the next regular expression is matched,
+ /// the end of input is encountered or an I/O-Error occurs.
+ /// </summary>
+ /// <returns>the next token</returns>
+ /// <exception cref="IOException">if any I/O-Error occurs</exception>
public int GetNextToken()
{
int zzInput;