http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9bd4dc81/src/Lucene.Net/Util/Automaton/SpecialOperations.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Util/Automaton/SpecialOperations.cs b/src/Lucene.Net/Util/Automaton/SpecialOperations.cs index 9de45e5..d5f75db 100644 --- a/src/Lucene.Net/Util/Automaton/SpecialOperations.cs +++ b/src/Lucene.Net/Util/Automaton/SpecialOperations.cs @@ -39,7 +39,7 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Special automata operations. - /// + /// <para/> /// @lucene.experimental /// </summary> internal sealed class SpecialOperations @@ -49,7 +49,7 @@ namespace Lucene.Net.Util.Automaton } /// <summary> - /// Finds the largest entry whose value is less than or equal to c, or 0 if + /// Finds the largest entry whose value is less than or equal to <paramref name="c"/>, or 0 if /// there is no such entry. /// </summary> internal static int FindIndex(int c, int[] points) @@ -76,7 +76,7 @@ namespace Lucene.Net.Util.Automaton } /// <summary> - /// Returns true if the language of this automaton is finite. + /// Returns <c>true</c> if the language of this automaton is finite. /// </summary> public static bool IsFinite(Automaton a) { @@ -88,7 +88,7 @@ namespace Lucene.Net.Util.Automaton } /// <summary> - /// Checks whether there is a loop containing s. (this is sufficient since + /// Checks whether there is a loop containing <paramref name="s"/>. (This is sufficient since /// there are never transitions to dead states.) /// </summary> // TODO: not great that this is recursive... in theory a @@ -112,7 +112,7 @@ namespace Lucene.Net.Util.Automaton /// Returns the longest string that is a prefix of all accepted strings and /// visits each state at most once. /// </summary> - /// <returns> common prefix </returns> + /// <returns> Common prefix. </returns> public static string GetCommonPrefix(Automaton a) { if (a.IsSingleton) @@ -182,7 +182,7 @@ namespace Lucene.Net.Util.Automaton /// Returns the longest string that is a suffix of all accepted strings and /// visits each state at most once. /// </summary> - /// <returns> common suffix </returns> + /// <returns> Common suffix. </returns> public static string GetCommonSuffix(Automaton a) { if (a.IsSingleton) // if singleton, the suffix is the string itself. @@ -281,8 +281,8 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Returns the set of accepted strings, assuming that at most - /// <code>limit</code> strings are accepted. If more than <code>limit</code> - /// strings are accepted, the first limit strings found are returned. If <code>limit</code><0, then + /// <paramref name="limit"/> strings are accepted. If more than <paramref name="limit"/> + /// strings are accepted, the first limit strings found are returned. If <paramref name="limit"/><0, then /// the limit is infinite. /// </summary> public static ISet<Int32sRef> GetFiniteStrings(Automaton a, int limit) @@ -304,8 +304,8 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Returns the strings that can be produced from the given state, or - /// false if more than <code>limit</code> strings are found. - /// <code>limit</code><0 means "infinite". + /// <c>false</c> if more than <paramref name="limit"/> strings are found. + /// <paramref name="limit"/><0 means "infinite". /// </summary> private static bool GetFiniteStrings(State s, HashSet<State> pathstates, HashSet<Int32sRef> strings, Int32sRef path, int limit) {
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9bd4dc81/src/Lucene.Net/Util/Automaton/State.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Util/Automaton/State.cs b/src/Lucene.Net/Util/Automaton/State.cs index b3df5a3..8db9cdb 100644 --- a/src/Lucene.Net/Util/Automaton/State.cs +++ b/src/Lucene.Net/Util/Automaton/State.cs @@ -37,8 +37,8 @@ using System.Text; namespace Lucene.Net.Util.Automaton { /// <summary> - /// <tt>Automaton</tt> state. - /// + /// <see cref="Automaton"/> state. + /// <para/> /// @lucene.experimental /// </summary> public class State : IComparable<State> @@ -150,7 +150,7 @@ namespace Lucene.Net.Util.Automaton /// Returns the set of outgoing transitions. Subsequent changes are reflected /// in the automaton. /// </summary> - /// <returns> transition set </returns> + /// <returns> Transition set. </returns> public virtual IEnumerable<Transition> GetTransitions() { return new TransitionsIterable(this); @@ -170,7 +170,7 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Adds an outgoing transition. /// </summary> - /// <param name="t"> transition </param> + /// <param name="t"> Transition. </param> public virtual void AddTransition(Transition t) { if (numTransitions == transitionsArray.Length) @@ -183,9 +183,8 @@ namespace Lucene.Net.Util.Automaton } /// <summary> - /// Sets acceptance for this state. + /// Sets acceptance for this state. If <c>true</c>, this state is an accept state. /// </summary> - /// <param name="accept"> if true, this state is an accept state </param> public virtual bool Accept { set @@ -201,9 +200,9 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Performs lookup in transitions, assuming determinism. /// </summary> - /// <param name="c"> codepoint to look up </param> - /// <returns> destination state, null if no matching outgoing transition </returns> - /// <seealso cref= #step(int, Collection) </seealso> + /// <param name="c"> Codepoint to look up. </param> + /// <returns> Destination state, <c>null</c> if no matching outgoing transition. </returns> + /// <seealso cref="Step(int, ICollection{State})"/> public virtual State Step(int c) { Debug.Assert(c >= 0); @@ -221,9 +220,9 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Performs lookup in transitions, allowing nondeterminism. /// </summary> - /// <param name="c"> codepoint to look up </param> - /// <param name="dest"> collection where destination states are stored </param> - /// <seealso cref= #step(int) </seealso> + /// <param name="c"> Codepoint to look up. </param> + /// <param name="dest"> Collection where destination states are stored. </param> + /// <seealso cref="Step(int)"/> public virtual void Step(int c, ICollection<State> dest) { for (int i = 0; i < numTransitions; i++) @@ -238,9 +237,9 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Virtually adds an epsilon transition to the target - /// {@code to} state. this is implemented by copying all - /// transitions from {@code to} to this state, and if {@code - /// to} is an accept state then set accept for this state. + /// <paramref name="to"/> state. this is implemented by copying all + /// transitions from <paramref name="to"/> to this state, and if + /// <paramref name="to"/> is an accept state then set accept for this state. /// </summary> internal virtual void AddEpsilon(State to) { @@ -255,7 +254,7 @@ namespace Lucene.Net.Util.Automaton } /// <summary> - /// Downsizes transitionArray to numTransitions </summary> + /// Downsizes transitionArray to numTransitions. </summary> public virtual void TrimTransitionsArray() { if (numTransitions < transitionsArray.Length) @@ -324,9 +323,8 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Returns sorted list of outgoing transitions. /// </summary> - /// <param name="to_first"> if true, order by (to, min, reverse max); otherwise (min, - /// reverse max, to) </param> - /// <returns> transition list </returns> + /// <param name="comparer"> Comparer to sort with. </param> + /// <returns> Transition list. </returns> /// <summary> /// Sorts transitions array in-place. </summary> @@ -341,10 +339,10 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Return this state's number. - /// <p> - /// Expert: Will be useless unless <seealso cref="Automaton#getNumberedStates"/> + /// <para/> + /// Expert: Will be useless unless <see cref="Automaton.GetNumberedStates()"/> /// has been called first to number the states. </summary> - /// <returns> the number </returns> + /// <returns> The number. </returns> public virtual int Number { get @@ -355,7 +353,7 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Returns string describing this state. Normally invoked via - /// <seealso cref="Automaton#toString()"/>. + /// <see cref="Automaton.ToString()"/>. /// </summary> public override string ToString() { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9bd4dc81/src/Lucene.Net/Util/Automaton/StatePair.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Util/Automaton/StatePair.cs b/src/Lucene.Net/Util/Automaton/StatePair.cs index 6b7b182..939c386 100644 --- a/src/Lucene.Net/Util/Automaton/StatePair.cs +++ b/src/Lucene.Net/Util/Automaton/StatePair.cs @@ -31,7 +31,7 @@ namespace Lucene.Net.Util.Automaton { /// <summary> /// Pair of states. - /// + /// <para/> /// @lucene.experimental /// </summary> public class StatePair @@ -50,8 +50,8 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Constructs a new state pair. /// </summary> - /// <param name="s1"> first state </param> - /// <param name="s2"> second state </param> + /// <param name="s1"> First state. </param> + /// <param name="s2"> Second state. </param> public StatePair(State s1, State s2) { this.S1 = s1; @@ -61,7 +61,7 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Returns first component of this pair. /// </summary> - /// <returns> first state </returns> + /// <returns> First state. </returns> public virtual State FirstState { get @@ -73,7 +73,7 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Returns second component of this pair. /// </summary> - /// <returns> second state </returns> + /// <returns> Second state. </returns> public virtual State SecondState { get @@ -85,9 +85,9 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Checks for equality. /// </summary> - /// <param name="obj"> object to compare with </param> - /// <returns> true if <tt>obj</tt> represents the same pair of states as this - /// pair </returns> + /// <param name="obj"> Object to compare with. </param> + /// <returns> <c>true</c> if <paramref name="obj"/> represents the same pair of states as this + /// pair. </returns> public override bool Equals(object obj) { if (obj is StatePair) @@ -104,7 +104,7 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Returns hash code. /// </summary> - /// <returns> hash code </returns> + /// <returns> Hash code. </returns> public override int GetHashCode() { return S1.GetHashCode() + S2.GetHashCode(); http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9bd4dc81/src/Lucene.Net/Util/Automaton/Transition.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Util/Automaton/Transition.cs b/src/Lucene.Net/Util/Automaton/Transition.cs index 4b6ffe3..545deb5 100644 --- a/src/Lucene.Net/Util/Automaton/Transition.cs +++ b/src/Lucene.Net/Util/Automaton/Transition.cs @@ -35,11 +35,11 @@ using System.Text; namespace Lucene.Net.Util.Automaton { /// <summary> - /// <tt>Automaton</tt> transition. - /// <p> + /// <see cref="Automaton"/> transition. + /// <para/> /// A transition, which belongs to a source state, consists of a Unicode /// codepoint interval and a destination state. - /// + /// <para/> /// @lucene.experimental /// </summary> public class Transition @@ -55,8 +55,8 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Constructs a new singleton interval transition. /// </summary> - /// <param name="c"> transition codepoint </param> - /// <param name="to"> destination state </param> + /// <param name="c"> Transition codepoint. </param> + /// <param name="to"> Destination state. </param> public Transition(int c, State to) { Debug.Assert(c >= 0); @@ -67,9 +67,9 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Constructs a new transition. Both end points are included in the interval. /// </summary> - /// <param name="min"> transition interval minimum </param> - /// <param name="max"> transition interval maximum </param> - /// <param name="to"> destination state </param> + /// <param name="min"> Transition interval minimum. </param> + /// <param name="max"> Transition interval maximum. </param> + /// <param name="to"> Destination state. </param> public Transition(int min, int max, State to) { Debug.Assert(min >= 0); @@ -118,8 +118,8 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Checks for equality. /// </summary> - /// <param name="obj"> object to compare with </param> - /// <returns> true if <tt>obj</tt> is a transition with same character interval + /// <param name="obj"> Object to compare with. </param> + /// <returns> <c>true</c> if <paramref name="obj"/> is a transition with same character interval /// and destination state as this transition. </returns> public override bool Equals(object obj) { @@ -138,7 +138,7 @@ namespace Lucene.Net.Util.Automaton /// Returns hash code. The hash code is based on the character interval (not /// the destination state). /// </summary> - /// <returns> hash code </returns> + /// <returns> Hash code. </returns> public override int GetHashCode() { return min * 2 + max * 3; @@ -147,7 +147,7 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Clones this transition. /// </summary> - /// <returns> clone with same character interval and destination state </returns> + /// <returns> Clone with same character interval and destination state. </returns> public virtual object Clone() { return (Transition)base.MemberwiseClone(); @@ -200,7 +200,7 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Returns a string describing this state. Normally invoked via - /// <seealso cref="Automaton#toString()"/>. + /// <seealso cref="Automaton.ToString()"/>. /// </summary> public override string ToString() { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/9bd4dc81/src/Lucene.Net/Util/Automaton/UTF32ToUTF8.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Util/Automaton/UTF32ToUTF8.cs b/src/Lucene.Net/Util/Automaton/UTF32ToUTF8.cs index 2f4646a..65d08ee 100644 --- a/src/Lucene.Net/Util/Automaton/UTF32ToUTF8.cs +++ b/src/Lucene.Net/Util/Automaton/UTF32ToUTF8.cs @@ -28,6 +28,7 @@ namespace Lucene.Net.Util.Automaton /// <summary> /// Converts UTF-32 automata to the equivalent UTF-8 representation. + /// <para/> /// @lucene.internal /// </summary> public sealed class UTF32ToUTF8 @@ -301,11 +302,11 @@ namespace Lucene.Net.Util.Automaton private int utf8StateCount; /// <summary> - /// Converts an incoming utf32 automaton to an equivalent - /// utf8 one. The incoming automaton need not be - /// deterministic. Note that the returned automaton will - /// not in general be deterministic, so you must - /// determinize it if that's needed. + /// Converts an incoming utf32 <see cref="Automaton"/> to an equivalent + /// utf8 one. The incoming automaton need not be + /// deterministic. Note that the returned automaton will + /// not in general be deterministic, so you must + /// determinize it if that's needed. /// </summary> public Automaton Convert(Automaton utf32) {
