You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by cc...@apache.org on 2011/11/06 06:24:44 UTC
[Lucene.Net] svn commit: r1198132 [9/17] - in /incubator/lucene.net/trunk/src:
contrib/Analyzers/AR/ contrib/Analyzers/BR/ contrib/Analyzers/CJK/
contrib/Analyzers/Cz/ contrib/Analyzers/De/ contrib/Analyzers/Fr/
contrib/Analyzers/Miscellaneous/ contrib/Analyzers/NG...
Modified: incubator/lucene.net/trunk/src/core/Index/KeepOnlyLastCommitDeletionPolicy.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/KeepOnlyLastCommitDeletionPolicy.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/KeepOnlyLastCommitDeletionPolicy.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/KeepOnlyLastCommitDeletionPolicy.cs Sun Nov 6 05:24:26 2011
@@ -20,7 +20,7 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary> This {@link IndexDeletionPolicy} implementation that
+ /// <summary> This <see cref="IndexDeletionPolicy" /> implementation that
/// keeps only the most recent commit and immediately removes
/// all prior commits after a new commit is done. This is
/// the default deletion policy.
Modified: incubator/lucene.net/trunk/src/core/Index/LogByteSizeMergePolicy.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/LogByteSizeMergePolicy.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/LogByteSizeMergePolicy.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/LogByteSizeMergePolicy.cs Sun Nov 6 05:24:26 2011
@@ -20,18 +20,18 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary>This is a {@link LogMergePolicy} that measures size of a
+ /// <summary>This is a <see cref="LogMergePolicy" /> that measures size of a
/// segment as the total byte size of the segment's files.
/// </summary>
public class LogByteSizeMergePolicy:LogMergePolicy
{
- /// <seealso cref="setMinMergeMB">
+ /// <seealso cref="SetMinMergeMB">
/// </seealso>
public const double DEFAULT_MIN_MERGE_MB = 1.6;
/// <summary>Default maximum segment size. A segment of this size</summary>
- /// <seealso cref="setMaxMergeMB">
+ /// <seealso cref="SetMaxMergeMB">
/// </seealso>
public static readonly long DEFAULT_MAX_MERGE_MB = System.Int64.MaxValue;
@@ -55,7 +55,7 @@ namespace Lucene.Net.Index
/// seconds. Larger values are best for batched indexing
/// and speedier searches.<p/>
///
- /// <p/>Note that {@link #setMaxMergeDocs} is also
+ /// <p/>Note that <see cref="IndexWriter.SetMaxMergeDocs" /> is also
/// used to check whether a segment is too large for
/// merging (it's either or).<p/>
/// </summary>
@@ -73,7 +73,7 @@ namespace Lucene.Net.Index
/// size of the segment's files, in MB) that may be merged
/// with other segments.
/// </summary>
- /// <seealso cref="setMaxMergeMB">
+ /// <seealso cref="SetMaxMergeMB">
/// </seealso>
public virtual double GetMaxMergeMB()
{
@@ -98,7 +98,7 @@ namespace Lucene.Net.Index
/// <summary>Get the minimum size for a segment to remain
/// un-merged.
/// </summary>
- /// <seealso cref="setMinMergeMB">
+ /// <seealso cref="SetMinMergeMB">
/// </seealso>
public virtual double GetMinMergeMB()
{
Modified: incubator/lucene.net/trunk/src/core/Index/LogDocMergePolicy.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/LogDocMergePolicy.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/LogDocMergePolicy.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/LogDocMergePolicy.cs Sun Nov 6 05:24:26 2011
@@ -20,7 +20,7 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary>This is a {@link LogMergePolicy} that measures size of a
+ /// <summary>This is a <see cref="LogMergePolicy" /> that measures size of a
/// segment as the number of documents (not taking deletions
/// into account).
/// </summary>
@@ -28,7 +28,7 @@ namespace Lucene.Net.Index
public class LogDocMergePolicy:LogMergePolicy
{
- /// <seealso cref="setMinMergeDocs">
+ /// <seealso cref="SetMinMergeDocs">
/// </seealso>
public const int DEFAULT_MIN_MERGE_DOCS = 1000;
@@ -63,7 +63,7 @@ namespace Lucene.Net.Index
/// <summary>Get the minimum size for a segment to remain
/// un-merged.
/// </summary>
- /// <seealso cref="setMinMergeDocs">
+ /// <seealso cref="SetMinMergeDocs">
/// </seealso>
public virtual int GetMinMergeDocs()
{
Modified: incubator/lucene.net/trunk/src/core/Index/LogMergePolicy.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/LogMergePolicy.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/LogMergePolicy.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/LogMergePolicy.cs Sun Nov 6 05:24:26 2011
@@ -20,20 +20,20 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary><p/>This class implements a {@link MergePolicy} that tries
+ /// <summary><p/>This class implements a <see cref="MergePolicy" /> that tries
/// to merge segments into levels of exponentially
/// increasing size, where each level has fewer segments than
/// the value of the merge factor. Whenever extra segments
/// (beyond the merge factor upper bound) are encountered,
/// all segments within the level are merged. You can get or
- /// set the merge factor using {@link #GetMergeFactor()} and
- /// {@link #SetMergeFactor(int)} respectively.<p/>
+ /// set the merge factor using <see cref="GetMergeFactor()" /> and
+ /// <see cref="SetMergeFactor(int)" /> respectively.<p/>
///
/// <p/>This class is abstract and requires a subclass to
- /// define the {@link #size} method which specifies how a
- /// segment's size is determined. {@link LogDocMergePolicy}
+ /// define the <see cref="Size" /> method which specifies how a
+ /// segment's size is determined. <see cref="LogDocMergePolicy" />
/// is one subclass that measures size by document count in
- /// the segment. {@link LogByteSizeMergePolicy} is another
+ /// the segment. <see cref="LogByteSizeMergePolicy" /> is another
/// subclass that measures size as the total byte size of the
/// file(s) for the segment.<p/>
/// </summary>
@@ -54,13 +54,13 @@ namespace Lucene.Net.Index
public const int DEFAULT_MERGE_FACTOR = 10;
/// <summary>Default maximum segment size. A segment of this size</summary>
- /// <seealso cref="setMaxMergeDocs">
+ /// <seealso cref="SetMaxMergeDocs">
/// </seealso>
public static readonly int DEFAULT_MAX_MERGE_DOCS = System.Int32.MaxValue;
/// <summary> Default noCFSRatio. If a merge's size is >= 10% of
/// the index, then we disable compound file for it.
- /// @see #setNoCFSRatio
+ /// See <see cref="SetNoCFSRatio"/>
/// </summary>
public static double DEFAULT_NO_CFS_RATIO = 0.1;
@@ -88,7 +88,9 @@ namespace Lucene.Net.Index
}
- /** @see #setNoCFSRatio */
+ /// <summary>
+ /// <see cref="SetNoCFSRatio"/>
+ /// </summary>
public double GetNoCFSRatio()
{
return noCFSRatio;
@@ -272,7 +274,7 @@ namespace Lucene.Net.Index
/// deletions pending nor separate norms, and it is in
/// compound file format if the current useCompoundFile
/// setting is true. This method returns multiple merges
- /// (mergeFactor at a time) so the {@link MergeScheduler}
+ /// (mergeFactor at a time) so the <see cref="MergeScheduler" />
/// in use may make use of concurrency.
/// </summary>
public override MergeSpecification FindMergesForOptimize(SegmentInfos infos, int maxNumSegments, System.Collections.Hashtable segmentsToOptimize)
@@ -422,12 +424,12 @@ namespace Lucene.Net.Index
}
/// <summary>Checks if any merges are now necessary and returns a
- /// {@link MergePolicy.MergeSpecification} if so. A merge
- /// is necessary when there are more than {@link
- /// #setMergeFactor} segments at a given level. When
+ /// <see cref="MergePolicy.MergeSpecification" /> if so. A merge
+ /// is necessary when there are more than <see cref="SetMergeFactor" />
+ /// segments at a given level. When
/// multiple levels have too many segments, this method
- /// will return multiple merges, allowing the {@link
- /// MergeScheduler} to use concurrency.
+ /// will return multiple merges, allowing the <see cref="MergeScheduler" />
+ /// to use concurrency.
/// </summary>
public override MergeSpecification FindMerges(SegmentInfos infos)
{
@@ -580,12 +582,12 @@ namespace Lucene.Net.Index
/// are best for batched indexing and speedier
/// searches.<p/>
///
- /// <p/>The default value is {@link Integer#MAX_VALUE}.<p/>
+ /// <p/>The default value is <see cref="int.MaxValue" />.<p/>
///
- /// <p/>The default merge policy ({@link
- /// LogByteSizeMergePolicy}) also allows you to set this
- /// limit by net size (in MB) of the segment, using {@link
- /// LogByteSizeMergePolicy#setMaxMergeMB}.<p/>
+ /// <p/>The default merge policy (<see cref="LogByteSizeMergePolicy" />)
+ /// also allows you to set this
+ /// limit by net size (in MB) of the segment, using
+ /// <see cref="LogByteSizeMergePolicy.SetMaxMergeMB" />.<p/>
/// </summary>
public virtual void SetMaxMergeDocs(int maxMergeDocs)
{
@@ -595,7 +597,7 @@ namespace Lucene.Net.Index
/// <summary>Returns the largest segment (measured by document
/// count) that may be merged with other segments.
/// </summary>
- /// <seealso cref="setMaxMergeDocs">
+ /// <seealso cref="SetMaxMergeDocs">
/// </seealso>
public virtual int GetMaxMergeDocs()
{
Modified: incubator/lucene.net/trunk/src/core/Index/MergePolicy.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/MergePolicy.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/MergePolicy.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/MergePolicy.cs Sun Nov 6 05:24:26 2011
@@ -27,32 +27,32 @@ namespace Lucene.Net.Index
/// and optimize operations.<p/>
///
/// <p/>Whenever the segments in an index have been altered by
- /// {@link IndexWriter}, either the addition of a newly
+ /// <see cref="IndexWriter" />, either the addition of a newly
/// flushed segment, addition of many segments from
/// addIndexes* calls, or a previous merge that may now need
- /// to cascade, {@link IndexWriter} invokes {@link
- /// #findMerges} to give the MergePolicy a chance to pick
+ /// to cascade, <see cref="IndexWriter" /> invokes <see cref="FindMerges" />
+ /// to give the MergePolicy a chance to pick
/// merges that are now required. This method returns a
- /// {@link MergeSpecification} instance describing the set of
+ /// <see cref="MergeSpecification" /> instance describing the set of
/// merges that should be done, or null if no merges are
/// necessary. When IndexWriter.optimize is called, it calls
- /// {@link #findMergesForOptimize} and the MergePolicy should
+ /// <see cref="FindMergesForOptimize" /> and the MergePolicy should
/// then return the necessary merges.<p/>
///
/// <p/>Note that the policy can return more than one merge at
- /// a time. In this case, if the writer is using {@link
- /// SerialMergeScheduler}, the merges will be run
- /// sequentially but if it is using {@link
- /// ConcurrentMergeScheduler} they will be run concurrently.<p/>
+ /// a time. In this case, if the writer is using <see cref="SerialMergeScheduler" />
+ ///, the merges will be run
+ /// sequentially but if it is using <see cref="ConcurrentMergeScheduler" />
+ /// they will be run concurrently.<p/>
///
- /// <p/>The default MergePolicy is {@link
- /// LogByteSizeMergePolicy}.<p/>
+ /// <p/>The default MergePolicy is <see cref="LogByteSizeMergePolicy" />
+ ///.<p/>
///
/// <p/><b>NOTE:</b> This API is new and still experimental
/// (subject to change suddenly in the next release)<p/>
///
/// <p/><b>NOTE</b>: This class typically requires access to
- /// package-private APIs (e.g. <code>SegmentInfos</code>) to do its job;
+ /// package-private APIs (e.g. <c>SegmentInfos</c>) to do its job;
/// if you implement your own MergePolicy, you'll need to put
/// it in package Lucene.Net.Index in order to use
/// these APIs.
@@ -106,8 +106,8 @@ namespace Lucene.Net.Index
}
}
- /// <summary>Retrieve previous exception set by {@link
- /// #setException}.
+ /// <summary>Retrieve previous exception set by <see cref="SetException" />
+ ///.
/// </summary>
internal virtual System.Exception GetException()
{
@@ -176,7 +176,7 @@ namespace Lucene.Net.Index
/// <summary> A MergeSpecification instance provides the information
/// necessary to perform multiple merges. It simply
- /// contains a list of {@link OneMerge} instances.
+ /// contains a list of <see cref="OneMerge" /> instances.
/// </summary>
public class MergeSpecification
@@ -210,7 +210,7 @@ namespace Lucene.Net.Index
{
private Directory dir;
/// <deprecated>
- /// Use {@link #MergePolicy.MergeException(String,Directory)} instead
+ /// Use <see cref="MergePolicy.MergeException(String,Directory)" /> instead
/// </deprecated>
[Obsolete("Use MergePolicy.MergeException(String,Directory) instead ")]
public MergeException(System.String message):base(message)
@@ -221,7 +221,7 @@ namespace Lucene.Net.Index
this.dir = dir;
}
/// <deprecated>
- /// Use {@link #MergePolicy.MergeException(Throwable,Directory)} instead
+ /// Use <see cref="MergePolicy.MergeException(Exception,Directory)" /> instead
/// </deprecated>
[Obsolete("Use MergePolicy.MergeException(Throwable,Directory) instead ")]
public MergeException(System.Exception exc):base(null, exc)
@@ -231,7 +231,7 @@ namespace Lucene.Net.Index
{
this.dir = dir;
}
- /// <summary>Returns the {@link Directory} of the index that hit
+ /// <summary>Returns the <see cref="Directory" /> of the index that hit
/// the exception.
/// </summary>
public virtual Directory GetDirectory()
@@ -259,8 +259,8 @@ namespace Lucene.Net.Index
}
/// <summary> Determine what set of merge operations are now necessary on the index.
- /// {@link IndexWriter} calls this whenever there is a change to the segments.
- /// This call is always synchronized on the {@link IndexWriter} instance so
+ /// <see cref="IndexWriter" /> calls this whenever there is a change to the segments.
+ /// This call is always synchronized on the <see cref="IndexWriter" /> instance so
/// only one thread at a time will call this method.
///
/// </summary>
@@ -269,9 +269,9 @@ namespace Lucene.Net.Index
public abstract MergeSpecification FindMerges(SegmentInfos segmentInfos);
/// <summary> Determine what set of merge operations is necessary in order to optimize
- /// the index. {@link IndexWriter} calls this when its
- /// {@link IndexWriter#Optimize()} method is called. This call is always
- /// synchronized on the {@link IndexWriter} instance so only one thread at a
+ /// the index. <see cref="IndexWriter" /> calls this when its
+ /// <see cref="IndexWriter.Optimize()" /> method is called. This call is always
+ /// synchronized on the <see cref="IndexWriter" /> instance so only one thread at a
/// time will call this method.
///
/// </summary>
Modified: incubator/lucene.net/trunk/src/core/Index/MergeScheduler.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/MergeScheduler.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/MergeScheduler.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/MergeScheduler.cs Sun Nov 6 05:24:26 2011
@@ -20,10 +20,10 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary><p/>Expert: {@link IndexWriter} uses an instance
+ /// <summary><p/>Expert: <see cref="IndexWriter" /> uses an instance
/// implementing this interface to execute the merges
- /// selected by a {@link MergePolicy}. The default
- /// MergeScheduler is {@link ConcurrentMergeScheduler}.<p/>
+ /// selected by a <see cref="MergePolicy" />. The default
+ /// MergeScheduler is <see cref="ConcurrentMergeScheduler" />.<p/>
///
/// <p/><b>NOTE:</b> This API is new and still experimental
/// (subject to change suddenly in the next release)<p/>
@@ -38,7 +38,7 @@ namespace Lucene.Net.Index
public abstract class MergeScheduler
{
- /// <summary>Run the merges provided by {@link IndexWriter#GetNextMerge()}. </summary>
+ /// <summary>Run the merges provided by <see cref="IndexWriter.GetNextMerge()" />. </summary>
public abstract void Merge(IndexWriter writer);
/// <summary>Close this MergeScheduler. </summary>
Modified: incubator/lucene.net/trunk/src/core/Index/MultiLevelSkipListReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/MultiLevelSkipListReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/MultiLevelSkipListReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/MultiLevelSkipListReader.cs Sun Nov 6 05:24:26 2011
@@ -25,10 +25,10 @@ namespace Lucene.Net.Index
/// <summary> This abstract class reads skip lists with multiple levels.
///
- /// See {@link MultiLevelSkipListWriter} for the information about the encoding
+ /// See <see cref="MultiLevelSkipListWriter" /> for the information about the encoding
/// of the multi level skip lists.
///
- /// Subclasses must implement the abstract method {@link #ReadSkipData(int, IndexInput)}
+ /// Subclasses must implement the abstract method <see cref="ReadSkipData(int, IndexInput)" />
/// which defines the actual format of the skip data.
/// </summary>
abstract class MultiLevelSkipListReader
@@ -83,7 +83,7 @@ namespace Lucene.Net.Index
}
- /// <summary>Returns the id of the doc to which the last call of {@link #SkipTo(int)}
+ /// <summary>Returns the id of the doc to which the last call of <see cref="SkipTo(int)" />
/// has skipped.
/// </summary>
internal virtual int GetDoc()
Modified: incubator/lucene.net/trunk/src/core/Index/MultiReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/MultiReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/MultiReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/MultiReader.cs Sun Nov 6 05:24:26 2011
@@ -106,7 +106,7 @@ namespace Lucene.Net.Index
/// A re-opened instance might share one or more subreaders with the old
/// instance. Index modification operations result in undefined behavior
/// when performed before the old instance is closed.
- /// (see {@link IndexReader#Reopen()}).
+ /// (see <see cref="IndexReader.Reopen()" />).
/// <p/>
/// If subreaders are shared, then the reference count of those
/// readers is increased to ensure that the subreaders remain open
@@ -124,7 +124,7 @@ namespace Lucene.Net.Index
}
/// <summary> Clones the subreaders.
- /// (see {@link IndexReader#clone()}).
+ /// (see <see cref="IndexReader.Clone()" />).
/// <br/>
/// <p/>
/// If subreaders are shared, then the reference count of those
Modified: incubator/lucene.net/trunk/src/core/Index/MultipleTermPositions.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/MultipleTermPositions.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/MultipleTermPositions.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/MultipleTermPositions.cs Sun Nov 6 05:24:26 2011
@@ -22,8 +22,8 @@ using PriorityQueue = Lucene.Net.Util.Pr
namespace Lucene.Net.Index
{
- /// <summary> Allows you to iterate over the {@link TermPositions} for multiple {@link Term}s as
- /// a single {@link TermPositions}.
+ /// <summary> Allows you to iterate over the <see cref="TermPositions" /> for multiple <see cref="Term" />s as
+ /// a single <see cref="TermPositions" />.
///
/// </summary>
public class MultipleTermPositions : TermPositions
@@ -113,10 +113,10 @@ namespace Lucene.Net.Index
private TermPositionsQueue _termPositionsQueue;
private IntQueue _posList;
- /// <summary> Creates a new <code>MultipleTermPositions</code> instance.
+ /// <summary> Creates a new <c>MultipleTermPositions</c> instance.
///
/// </summary>
- /// <exception cref="IOException">
+ /// <exception cref="System.IO.IOException">
/// </exception>
public MultipleTermPositions(IndexReader indexReader, Term[] terms)
{
Modified: incubator/lucene.net/trunk/src/core/Index/ParallelReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/ParallelReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/ParallelReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/ParallelReader.cs Sun Nov 6 05:24:26 2011
@@ -89,7 +89,7 @@ namespace Lucene.Net.Index
/// <summary> of documents
/// </summary>
/// <throws> IllegalArgumentException if not all indexes have the same value </throws>
- /// <summary> of {@link IndexReader#MaxDoc()}
+ /// <summary> of <see cref="IndexReader.MaxDoc()" />
/// </summary>
/// <throws> IOException if there is a low-level IO error </throws>
public virtual void Add(IndexReader reader, bool ignoreStoredFields)
@@ -152,7 +152,7 @@ namespace Lucene.Net.Index
/// A re-opened instance might share one or more subreaders with the old
/// instance. Index modification operations result in undefined behavior
/// when performed before the old instance is closed.
- /// (see {@link IndexReader#Reopen()}).
+ /// (see <see cref="IndexReader.Reopen()" />).
/// <p/>
/// If subreaders are shared, then the reference count of those
/// readers is increased to ensure that the subreaders remain open
Modified: incubator/lucene.net/trunk/src/core/Index/Payload.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/Payload.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/Payload.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/Payload.cs Sun Nov 6 05:24:26 2011
@@ -27,10 +27,10 @@ namespace Lucene.Net.Index
/// of a term. This metadata is stored inline in the posting list of the
/// specific term.
/// <p/>
- /// To store payloads in the index a {@link TokenStream} has to be used that
+ /// To store payloads in the index a <see cref="TokenStream"/> has to be used that
/// produces payload data.
/// <p/>
- /// Use {@link TermPositions#GetPayloadLength()} and {@link TermPositions#GetPayload(byte[], int)}
+ /// Use <see cref="TermPositions.GetPayloadLength()"/> and <see cref="TermPositions.GetPayload(byte[], int)"/>
/// to retrieve the payloads from the index.<br/>
///
/// </summary>
Modified: incubator/lucene.net/trunk/src/core/Index/PositionBasedTermVectorMapper.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/PositionBasedTermVectorMapper.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/PositionBasedTermVectorMapper.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/PositionBasedTermVectorMapper.cs Sun Nov 6 05:24:26 2011
@@ -108,7 +108,7 @@ namespace Lucene.Net.Index
/// <summary> Get the mapping between fields and terms, sorted by the comparator
///
/// </summary>
- /// <returns> A map between field names and a Map. The sub-Map key is the position as the integer, the value is {@link Lucene.Net.Index.PositionBasedTermVectorMapper.TVPositionInfo}.
+ /// <returns> A map between field names and a Map. The sub-Map key is the position as the integer, the value is <see cref="Lucene.Net.Index.PositionBasedTermVectorMapper.TVPositionInfo" />.
/// </returns>
public virtual System.Collections.IDictionary GetFieldToTerms()
{
@@ -140,7 +140,8 @@ namespace Lucene.Net.Index
}
}
- /// <summary> Parallel list (to {@link #getTerms()}) of TermVectorOffsetInfo objects. There may be multiple entries since there may be multiple terms at a position</summary>
+ /// <summary> Parallel list (to <see cref="Terms" />) of TermVectorOffsetInfo objects.
+ /// There may be multiple entries since there may be multiple terms at a position</summary>
/// <returns> A List of TermVectorOffsetInfo objects, if offsets are store.
/// </returns>
virtual public System.Collections.IList Offsets
Modified: incubator/lucene.net/trunk/src/core/Index/RawPostingList.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/RawPostingList.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/RawPostingList.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/RawPostingList.cs Sun Nov 6 05:24:26 2011
@@ -22,9 +22,9 @@ namespace Lucene.Net.Index
/// <summary>This is the base class for an in-memory posting list,
- /// keyed by a Token. {@link TermsHash} maintains a hash
+ /// keyed by a Token. <see cref="TermsHash" /> maintains a hash
/// table holding one instance of this per unique Token.
- /// Consumers of TermsHash ({@link TermsHashConsumer}) must
+ /// Consumers of TermsHash (<see cref="TermsHashConsumer" />) must
/// subclass this class with its own concrete class.
/// FreqProxTermsWriter.PostingList is a private inner class used
/// for the freq/prox postings, and
Modified: incubator/lucene.net/trunk/src/core/Index/SegmentInfos.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/SegmentInfos.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/SegmentInfos.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/SegmentInfos.cs Sun Nov 6 05:24:26 2011
@@ -129,7 +129,7 @@ namespace Lucene.Net.Index
private System.Collections.Generic.IDictionary<string, string> userData = new System.Collections.Generic.Dictionary<string, string>(); // Opaque Map<String, String> that user can specify during IndexWriter.commit
/// <summary> If non-null, information about loading segments_N files</summary>
- /// <seealso cref="setInfoStream">
+ /// <seealso cref="SetInfoStream">
/// </seealso>
private static System.IO.StreamWriter infoStream;
@@ -513,7 +513,7 @@ namespace Lucene.Net.Index
defaultGenFileRetryCount = count;
}
- /// <seealso cref="setDefaultGenFileRetryCount">
+ /// <seealso cref="SetDefaultGenFileRetryCount">
/// </seealso>
public static int GetDefaultGenFileRetryCount()
{
@@ -528,7 +528,7 @@ namespace Lucene.Net.Index
defaultGenFileRetryPauseMsec = msec;
}
- /// <seealso cref="setDefaultGenFileRetryPauseMsec">
+ /// <seealso cref="SetDefaultGenFileRetryPauseMsec">
/// </seealso>
public static int GetDefaultGenFileRetryPauseMsec()
{
@@ -545,14 +545,14 @@ namespace Lucene.Net.Index
{
defaultGenLookaheadCount = count;
}
- /// <seealso cref="setDefaultGenLookaheadCount">
+ /// <seealso cref="SetDefaultGenLookaheadCount">
/// </seealso>
public static int GetDefaultGenLookahedCount()
{
return defaultGenLookaheadCount;
}
- /// <seealso cref="setInfoStream">
+ /// <seealso cref="SetInfoStream">
/// </seealso>
public static System.IO.StreamWriter GetInfoStream()
{
@@ -895,8 +895,8 @@ namespace Lucene.Net.Index
/// <summary>Call this to start a commit. This writes the new
/// segments file, but writes an invalid checksum at the
/// end, so that it is not visible to readers. Once this
- /// is called you must call {@link #finishCommit} to complete
- /// the commit or {@link #rollbackCommit} to abort it.
+ /// is called you must call <see cref="FinishCommit" /> to complete
+ /// the commit or <see cref="RollbackCommit" /> to abort it.
/// </summary>
internal void PrepareCommit(Directory dir)
{
Modified: incubator/lucene.net/trunk/src/core/Index/SegmentMerger.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/SegmentMerger.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/SegmentMerger.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/SegmentMerger.cs Sun Nov 6 05:24:26 2011
@@ -29,7 +29,7 @@ using IndexOutput = Lucene.Net.Store.Ind
namespace Lucene.Net.Index
{
- /// <summary> The SegmentMerger class combines two or more Segments, represented by an IndexReader ({@link #add},
+ /// <summary> The SegmentMerger class combines two or more Segments, represented by an IndexReader (<see cref="Add" />,
/// into a single Segment. After adding the appropriate readers, call the merge method to combine the
/// segments.
/// <p/>
@@ -37,9 +37,9 @@ namespace Lucene.Net.Index
///
///
/// </summary>
- /// <seealso cref="merge">
+ /// <seealso cref="Merge()">
/// </seealso>
- /// <seealso cref="add">
+ /// <seealso cref="Add">
/// </seealso>
public sealed class SegmentMerger
{
@@ -200,7 +200,7 @@ namespace Lucene.Net.Index
return (IndexReader) readers[i];
}
- /// <summary> Merges the readers specified by the {@link #add} method into the directory passed to the constructor</summary>
+ /// <summary> Merges the readers specified by the <see cref="Add" /> method into the directory passed to the constructor</summary>
/// <returns> The number of documents that were merged
/// </returns>
/// <throws> CorruptIndexException if the index is corrupt </throws>
@@ -210,7 +210,7 @@ namespace Lucene.Net.Index
return Merge(true);
}
- /// <summary> Merges the readers specified by the {@link #add} method
+ /// <summary> Merges the readers specified by the <see cref="Add" /> method
/// into the directory passed to the constructor.
/// </summary>
/// <param name="mergeDocStores">if false, we will not merge the
Modified: incubator/lucene.net/trunk/src/core/Index/SegmentTermPositionVector.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/SegmentTermPositionVector.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/SegmentTermPositionVector.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/SegmentTermPositionVector.cs Sun Nov 6 05:24:26 2011
@@ -55,7 +55,7 @@ namespace Lucene.Net.Index
/// <summary> Returns an array of positions in which the term is found.
/// Terms are identified by the index at which its number appears in the
- /// term String array obtained from the <code>indexOf</code> method.
+ /// term String array obtained from the <c>indexOf</c> method.
/// </summary>
public virtual int[] GetTermPositions(int index)
{
Modified: incubator/lucene.net/trunk/src/core/Index/SerialMergeScheduler.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/SerialMergeScheduler.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/SerialMergeScheduler.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/SerialMergeScheduler.cs Sun Nov 6 05:24:26 2011
@@ -20,7 +20,7 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary>A {@link MergeScheduler} that simply does each merge
+ /// <summary>A <see cref="MergeScheduler" /> that simply does each merge
/// sequentially, using the current thread.
/// </summary>
public class SerialMergeScheduler:MergeScheduler
Modified: incubator/lucene.net/trunk/src/core/Index/SnapshotDeletionPolicy.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/SnapshotDeletionPolicy.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/SnapshotDeletionPolicy.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/SnapshotDeletionPolicy.cs Sun Nov 6 05:24:26 2011
@@ -22,15 +22,15 @@ using Directory = Lucene.Net.Store.Direc
namespace Lucene.Net.Index
{
- /// <summary>A {@link IndexDeletionPolicy} that wraps around any other
- /// {@link IndexDeletionPolicy} and adds the ability to hold and
+ /// <summary>A <see cref="IndexDeletionPolicy" /> that wraps around any other
+ /// <see cref="IndexDeletionPolicy" /> and adds the ability to hold and
/// later release a single "snapshot" of an index. While
- /// the snapshot is held, the {@link IndexWriter} will not
+ /// the snapshot is held, the <see cref="IndexWriter" /> will not
/// remove any files associated with it even if the index is
/// otherwise being actively, arbitrarily changed. Because
- /// we wrap another arbitrary {@link IndexDeletionPolicy}, this
- /// gives you the freedom to continue using whatever {@link
- /// IndexDeletionPolicy} you would normally want to use with your
+ /// we wrap another arbitrary <see cref="IndexDeletionPolicy" />, this
+ /// gives you the freedom to continue using whatever <see cref="IndexDeletionPolicy" />
+ /// you would normally want to use with your
/// index. Note that you can re-use a single instance of
/// SnapshotDeletionPolicy across multiple writers as long
/// as they are against the same index Directory. Any
Modified: incubator/lucene.net/trunk/src/core/Index/SortedTermVectorMapper.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/SortedTermVectorMapper.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/SortedTermVectorMapper.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/SortedTermVectorMapper.cs Sun Nov 6 05:24:26 2011
@@ -20,7 +20,7 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary> Store a sorted collection of {@link Lucene.Net.Index.TermVectorEntry}s. Collects all term information
+ /// <summary> Store a sorted collection of <see cref="Lucene.Net.Index.TermVectorEntry" />s. Collects all term information
/// into a single, SortedSet.
/// <br/>
/// NOTE: This Mapper ignores all Field information for the Document. This means that if you are using offset/positions you will not
@@ -36,11 +36,11 @@ namespace Lucene.Net.Index
private System.Collections.IDictionary termToTVE = new System.Collections.Hashtable();
private bool storeOffsets;
private bool storePositions;
- /// <summary> Stand-in name for the field in {@link TermVectorEntry}.</summary>
+ /// <summary> Stand-in name for the field in <see cref="TermVectorEntry" />.</summary>
public const System.String ALL = "_ALL_";
/// <summary> </summary>
- /// <param name="comparator">A Comparator for sorting {@link TermVectorEntry}s
+ /// <param name="comparator">A Comparator for sorting <see cref="TermVectorEntry" />s
/// </param>
public SortedTermVectorMapper(System.Collections.Generic.IComparer<System.Object> comparator):this(false, false, comparator)
{
@@ -117,12 +117,12 @@ namespace Lucene.Net.Index
this.storePositions = storePositions;
}
- /// <summary> The TermVectorEntrySet. A SortedSet of {@link TermVectorEntry} objects. Sort is by the comparator passed into the constructor.
+ /// <summary> The TermVectorEntrySet. A SortedSet of <see cref="TermVectorEntry" /> objects. Sort is by the comparator passed into the constructor.
/// <br/>
/// This set will be empty until after the mapping process takes place.
///
/// </summary>
- /// <returns> The SortedSet of {@link TermVectorEntry}.
+ /// <returns> The SortedSet of <see cref="TermVectorEntry" />.
/// </returns>
public virtual System.Collections.Generic.SortedDictionary<Object, Object> GetTermVectorEntrySet()
{
Modified: incubator/lucene.net/trunk/src/core/Index/StaleReaderException.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/StaleReaderException.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/StaleReaderException.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/StaleReaderException.cs Sun Nov 6 05:24:26 2011
@@ -20,10 +20,10 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary> This exception is thrown when an {@link IndexReader}
- /// tries to make changes to the index (via {@link
- /// IndexReader#deleteDocument}, {@link
- /// IndexReader#undeleteAll} or {@link IndexReader#setNorm})
+ /// <summary> This exception is thrown when an <see cref="IndexReader" />
+ /// tries to make changes to the index (via <see cref="IndexReader.DeleteDocument" />
+ ///, <see cref="IndexReader.UndeleteAll" />
+ /// or <see cref="IndexReader.SetNorm(int,string,float)" />)
/// but changes have already been committed to the index
/// since this reader was instantiated. When this happens
/// you must open a new reader on the current index to make
Modified: incubator/lucene.net/trunk/src/core/Index/TermBuffer.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermBuffer.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermBuffer.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermBuffer.cs Sun Nov 6 05:24:26 2011
@@ -58,7 +58,7 @@ namespace Lucene.Net.Index
return len1 - len2;
}
- /// <summary>Call this if the IndexInput passed to {@link #read}
+ /// <summary>Call this if the IndexInput passed to <see cref="Read" />
/// stores terms in the "modified UTF8" (pre LUCENE-510)
/// format.
/// </summary>
Modified: incubator/lucene.net/trunk/src/core/Index/TermDocs.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermDocs.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermDocs.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermDocs.cs Sun Nov 6 05:24:26 2011
@@ -36,18 +36,18 @@ namespace Lucene.Net.Index
/// </summary>
void Seek(Term term);
- /// <summary>Sets this to the data for the current term in a {@link TermEnum}.
+ /// <summary>Sets this to the data for the current term in a <see cref="TermEnum" />.
/// This may be optimized in some implementations.
/// </summary>
void Seek(TermEnum termEnum);
- /// <summary>Returns the current document number. <p/> This is invalid until {@link
- /// #Next()} is called for the first time.
+ /// <summary>Returns the current document number. <p/> This is invalid until <see cref="Next()" />
+ /// is called for the first time.
/// </summary>
int Doc();
/// <summary>Returns the frequency of the term within the current document. <p/> This
- /// is invalid until {@link #Next()} is called for the first time.
+ /// is invalid until <see cref="Next()" /> is called for the first time.
/// </summary>
int Freq();
@@ -68,15 +68,15 @@ namespace Lucene.Net.Index
/// <summary>Skips entries to the first beyond the current whose document number is
/// greater than or equal to <i>target</i>. <p/>Returns true iff there is such
- /// an entry. <p/>Behaves as if written: <pre>
+ /// an entry. <p/>Behaves as if written: <code>
/// boolean skipTo(int target) {
- /// do {
- /// if (!next())
- /// return false;
- /// } while (target > doc());
- /// return true;
+ /// do {
+ /// if (!next())
+ /// return false;
+ /// } while (target > doc());
+ /// return true;
/// }
- /// </pre>
+ /// </code>
/// Some implementations are considerably more efficient than that.
/// </summary>
bool SkipTo(int target);
Modified: incubator/lucene.net/trunk/src/core/Index/TermEnum.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermEnum.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermEnum.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermEnum.cs Sun Nov 6 05:24:26 2011
@@ -41,20 +41,20 @@ namespace Lucene.Net.Index
/// <summary>Skips terms to the first beyond the current whose value is
/// greater or equal to <i>target</i>. <p/>Returns true iff there is such
- /// an entry. <p/>Behaves as if written: <pre>
+ /// an entry. <p/>Behaves as if written: <code>
/// public boolean skipTo(Term target) {
- /// do {
- /// if (!next())
- /// return false;
- /// } while (target > term());
- /// return true;
+ /// do {
+ /// if (!next())
+ /// return false;
+ /// } while (target > term());
+ /// return true;
/// }
- /// </pre>
+ /// </code>
/// Some implementations *could* be considerably more efficient than a linear scan.
/// Check the implementation to be sure.
/// </summary>
/// <deprecated> This method is not performant and will be removed in Lucene 3.0.
- /// Use {@link IndexReader#Terms(Term)} to create a new TermEnum positioned at a
+ /// Use <see cref="IndexReader.Terms(Term)" /> to create a new TermEnum positioned at a
/// given term.
/// </deprecated>
[Obsolete("This method is not performant and will be removed in Lucene 3.0.Use IndexReader.Terms(Term) to create a new TermEnum positioned at a given term.")]
Modified: incubator/lucene.net/trunk/src/core/Index/TermFreqVector.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermFreqVector.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermFreqVector.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermFreqVector.cs Sun Nov 6 05:24:26 2011
@@ -22,12 +22,12 @@ namespace Lucene.Net.Index
/// <summary>Provides access to stored term vector of
/// a document field. The vector consists of the name of the field, an array of the terms tha occur in the field of the
- /// {@link Lucene.Net.Documents.Document} and a parallel array of frequencies. Thus, getTermFrequencies()[5] corresponds with the
+ /// <see cref="Lucene.Net.Documents.Document" /> and a parallel array of frequencies. Thus, getTermFrequencies()[5] corresponds with the
/// frequency of getTerms()[5], assuming there are at least 5 terms in the Document.
/// </summary>
public interface TermFreqVector
{
- /// <summary> The {@link Lucene.Net.Documents.Fieldable} name. </summary>
+ /// <summary> The <see cref="Lucene.Net.Documents.Fieldable" /> name. </summary>
/// <returns> The name of the field this vector is associated with.
///
/// </returns>
@@ -43,7 +43,7 @@ namespace Lucene.Net.Index
/// <summary>Array of term frequencies. Locations of the array correspond one to one
- /// to the terms in the array obtained from <code>getTerms</code>
+ /// to the terms in the array obtained from <c>getTerms</c>
/// method. Each location in the array contains the number of times this
/// term occurs in the document or the document field.
/// </summary>
@@ -51,14 +51,14 @@ namespace Lucene.Net.Index
/// <summary>Return an index in the term numbers array returned from
- /// <code>getTerms</code> at which the term with the specified
- /// <code>term</code> appears. If this term does not appear in the array,
+ /// <c>getTerms</c> at which the term with the specified
+ /// <c>term</c> appears. If this term does not appear in the array,
/// return -1.
/// </summary>
int IndexOf(System.String term);
- /// <summary>Just like <code>indexOf(int)</code> but searches for a number of terms
+ /// <summary>Just like <c>indexOf(int)</c> but searches for a number of terms
/// at the same time. Returns an array that has the same size as the number
/// of terms searched for, each slot containing the result of searching for
/// that term number.
Modified: incubator/lucene.net/trunk/src/core/Index/TermInfosWriter.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermInfosWriter.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermInfosWriter.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermInfosWriter.cs Sun Nov 6 05:24:26 2011
@@ -60,8 +60,8 @@ namespace Lucene.Net.Index
/// </summary>
internal int indexInterval = 128;
- /// <summary>Expert: The fraction of {@link TermDocs} entries stored in skip tables,
- /// used to accellerate {@link TermDocs#SkipTo(int)}. Larger values result in
+ /// <summary>Expert: The fraction of <see cref="TermDocs" /> entries stored in skip tables,
+ /// used to accellerate <see cref="TermDocs.SkipTo(int)" />. Larger values result in
/// smaller indexes, greater acceleration, but fewer accelerable cases, while
/// smaller values result in bigger indexes, less acceleration and more
/// accelerable cases. More detailed experiments would be useful here.
Modified: incubator/lucene.net/trunk/src/core/Index/TermPositionVector.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermPositionVector.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermPositionVector.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermPositionVector.cs Sun Nov 6 05:24:26 2011
@@ -20,7 +20,7 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary>Extends <code>TermFreqVector</code> to provide additional information about
+ /// <summary>Extends <c>TermFreqVector</c> to provide additional information about
/// positions in which each of the terms is found. A TermPositionVector not necessarily
/// contains both positions and offsets, but at least one of these arrays exists.
/// </summary>
@@ -29,7 +29,7 @@ namespace Lucene.Net.Index
/// <summary>Returns an array of positions in which the term is found.
/// Terms are identified by the index at which its number appears in the
- /// term String array obtained from the <code>indexOf</code> method.
+ /// term String array obtained from the <c>indexOf</c> method.
/// May return null if positions have not been stored.
/// </summary>
int[] GetTermPositions(int index);
Modified: incubator/lucene.net/trunk/src/core/Index/TermPositions.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermPositions.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermPositions.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermPositions.cs Sun Nov 6 05:24:26 2011
@@ -32,15 +32,15 @@ namespace Lucene.Net.Index
public interface TermPositions:TermDocs
{
/// <summary>Returns next position in the current document. It is an error to call
- /// this more than {@link #Freq()} times
- /// without calling {@link #Next()}<p/> This is
- /// invalid until {@link #Next()} is called for
+ /// this more than <see cref="TermDocs.Freq()" /> times
+ /// without calling <see cref="TermDocs.Next()" /><p/> This is
+ /// invalid until <see cref="TermDocs.Next()" /> is called for
/// the first time.
/// </summary>
int NextPosition();
/// <summary> Returns the length of the payload at the current term position.
- /// This is invalid until {@link #NextPosition()} is called for
+ /// This is invalid until <see cref="NextPosition()" /> is called for
/// the first time.<br/>
/// </summary>
/// <returns> length of the current payload in number of bytes
@@ -48,10 +48,10 @@ namespace Lucene.Net.Index
int GetPayloadLength();
/// <summary> Returns the payload data at the current term position.
- /// This is invalid until {@link #NextPosition()} is called for
+ /// This is invalid until <see cref="NextPosition()" /> is called for
/// the first time.
/// This method must not be called more than once after each call
- /// of {@link #NextPosition()}. However, payloads are loaded lazily,
+ /// of <see cref="NextPosition()" />. However, payloads are loaded lazily,
/// so if the payload data for the current position is not needed,
/// this method may not be called at all for performance reasons.<br/>
///
@@ -71,7 +71,7 @@ namespace Lucene.Net.Index
/// <summary> Checks if a payload can be loaded at this position.
/// <p/>
/// Payloads can only be loaded once per call to
- /// {@link #NextPosition()}.
+ /// <see cref="NextPosition()" />.
///
/// </summary>
/// <returns> true if there is a payload available at this position that can be loaded
Modified: incubator/lucene.net/trunk/src/core/Index/TermVectorEntryFreqSortedComparator.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermVectorEntryFreqSortedComparator.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermVectorEntryFreqSortedComparator.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermVectorEntryFreqSortedComparator.cs Sun Nov 6 05:24:26 2011
@@ -20,7 +20,7 @@ using System;
namespace Lucene.Net.Index
{
- /// <summary> Compares {@link Lucene.Net.Index.TermVectorEntry}s first by frequency and then by
+ /// <summary> Compares <see cref="Lucene.Net.Index.TermVectorEntry" />s first by frequency and then by
/// the term (case-sensitive)
///
///
Modified: incubator/lucene.net/trunk/src/core/Index/TermVectorMapper.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermVectorMapper.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermVectorMapper.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermVectorMapper.cs Sun Nov 6 05:24:26 2011
@@ -22,7 +22,7 @@ namespace Lucene.Net.Index
/// <summary> The TermVectorMapper can be used to map Term Vectors into your own
/// structure instead of the parallel array structure used by
- /// {@link Lucene.Net.Index.IndexReader#GetTermFreqVector(int,String)}.
+ /// <see cref="Lucene.Net.Index.IndexReader.GetTermFreqVector(int,String)" />.
/// <p/>
/// It is up to the implementation to make sure it is thread-safe.
///
@@ -54,7 +54,7 @@ namespace Lucene.Net.Index
/// <summary> Tell the mapper what to expect in regards to field, number of terms, offset and position storage.
/// This method will be called once before retrieving the vector for a field.
///
- /// This method will be called before {@link #Map(String,int,TermVectorOffsetInfo[],int[])}.
+ /// This method will be called before <see cref="Map(String,int,TermVectorOffsetInfo[],int[])" />.
/// </summary>
/// <param name="field">The field the vector is for
/// </param>
@@ -88,7 +88,7 @@ namespace Lucene.Net.Index
}
/// <summary> </summary>
- /// <seealso cref="IsIgnoringPositions()"> Same principal as {@link #IsIgnoringPositions()}, but applied to offsets. false by default.
+ /// <seealso cref="IsIgnoringPositions()"> Same principal as <see cref="IsIgnoringPositions()" />, but applied to offsets. false by default.
/// </seealso>
/// <returns> false
/// </returns>
Modified: incubator/lucene.net/trunk/src/core/Index/TermVectorOffsetInfo.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermVectorOffsetInfo.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermVectorOffsetInfo.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermVectorOffsetInfo.cs Sun Nov 6 05:24:26 2011
@@ -22,14 +22,14 @@ using System.Runtime.InteropServices;
namespace Lucene.Net.Index
{
- /// <summary> The TermVectorOffsetInfo class holds information pertaining to a Term in a {@link Lucene.Net.Index.TermPositionVector}'s
+ /// <summary> The TermVectorOffsetInfo class holds information pertaining to a Term in a <see cref="Lucene.Net.Index.TermPositionVector" />'s
/// offset information. This offset information is the character offset as set during the Analysis phase (and thus may not be the actual offset in the
/// original content).
/// </summary>
[Serializable]
public class TermVectorOffsetInfo
{
- /// <summary> Convenience declaration when creating a {@link Lucene.Net.Index.TermPositionVector} that stores only position information.</summary>
+ /// <summary> Convenience declaration when creating a <see cref="Lucene.Net.Index.TermPositionVector" /> that stores only position information.</summary>
[NonSerialized]
public static readonly TermVectorOffsetInfo[] EMPTY_OFFSET_INFO = new TermVectorOffsetInfo[0];
private int startOffset;
@@ -76,7 +76,7 @@ namespace Lucene.Net.Index
/// <summary> Two TermVectorOffsetInfos are equals if both the start and end offsets are the same</summary>
/// <param name="o">The comparison Object
/// </param>
- /// <returns> true if both {@link #GetStartOffset()} and {@link #GetEndOffset()} are the same for both objects.
+ /// <returns> true if both <see cref="GetStartOffset()" /> and <see cref="GetEndOffset()" /> are the same for both objects.
/// </returns>
public override bool Equals(System.Object o)
{
Modified: incubator/lucene.net/trunk/src/core/Index/TermVectorsReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermVectorsReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermVectorsReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermVectorsReader.cs Sun Nov 6 05:24:26 2011
@@ -699,7 +699,7 @@ namespace Lucene.Net.Index
}
/// <summary> Construct the vector</summary>
- /// <returns> The {@link TermFreqVector} based on the mappings.
+ /// <returns> The <see cref="TermFreqVector" /> based on the mappings.
/// </returns>
public virtual TermFreqVector MaterializeVector()
{
Modified: incubator/lucene.net/trunk/src/core/Index/TermsHash.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermsHash.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermsHash.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermsHash.cs Sun Nov 6 05:24:26 2011
@@ -22,12 +22,12 @@ using ArrayUtil = Lucene.Net.Util.ArrayU
namespace Lucene.Net.Index
{
- /// <summary>This class implements {@link InvertedDocConsumer}, which
+ /// <summary>This class implements <see cref="InvertedDocConsumer" />, which
/// is passed each token produced by the analyzer on each
/// field. It stores these tokens in a hash table, and
/// allocates separate byte streams per token. Consumers of
- /// this class, eg {@link FreqProxTermsWriter} and {@link
- /// TermVectorsTermsWriter}, write their own byte streams
+ /// this class, eg <see cref="FreqProxTermsWriter" /> and <see cref="TermVectorsTermsWriter" />
+ ///, write their own byte streams
/// under each term.
/// </summary>
Modified: incubator/lucene.net/trunk/src/core/Index/TermsHashConsumerPerField.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/TermsHashConsumerPerField.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/TermsHashConsumerPerField.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/TermsHashConsumerPerField.cs Sun Nov 6 05:24:26 2011
@@ -15,20 +15,17 @@
* limitations under the License.
*/
-
-/// <summary>Implement this class to plug into the TermsHash
-/// processor, which inverts & stores Tokens into a hash
-/// table and provides an API for writing bytes into
-/// multiple streams for each unique Token.
-/// </summary>
-
using System;
using Fieldable = Lucene.Net.Documents.Fieldable;
namespace Lucene.Net.Index
{
-
+ /// <summary>Implement this class to plug into the TermsHash
+ /// processor, which inverts and stores Tokens into a hash
+ /// table and provides an API for writing bytes into
+ /// multiple streams for each unique Token.
+ /// </summary>
abstract class TermsHashConsumerPerField
{
internal abstract bool Start(Fieldable[] fields, int count);
Modified: incubator/lucene.net/trunk/src/core/LucenePackage.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/LucenePackage.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/LucenePackage.cs (original)
+++ incubator/lucene.net/trunk/src/core/LucenePackage.cs Sun Nov 6 05:24:26 2011
@@ -27,14 +27,14 @@ namespace Lucene.Net
private LucenePackage()
{
} // can't construct
-
- /// <summary>Return Lucene's package, including version information. </summary>
- // {{Aroush-1.9}}
+
/*
- public static Package Get()
- {
- return typeof(LucenePackage).getPackage();
- }
+ * /// <summary>Return Lucene's package, including version information. </summary>
+ // {{Aroush-1.9}}
+ public static Package Get()
+ {
+ return typeof(LucenePackage).getPackage();
+ }
*/
}
}
\ No newline at end of file
Modified: incubator/lucene.net/trunk/src/core/Messages/NLS.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Messages/NLS.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Messages/NLS.cs (original)
+++ incubator/lucene.net/trunk/src/core/Messages/NLS.cs Sun Nov 6 05:24:26 2011
@@ -170,12 +170,13 @@ namespace Lucene.Net.Messages
LoadfieldValue(fieldArray[i], isFieldAccessible, clazz);
}
}
-
- /// <param name="field">
- /// </param>
- /// <param name="isFieldAccessible">
- /// </param>
- private static void LoadfieldValue(System.Reflection.FieldInfo field, bool isFieldAccessible, System.Type clazz)
+
+ /// <param name="field">
+ /// </param>
+ /// <param name="isFieldAccessible">
+ /// </param>
+ /// <param name="clazz"></param>
+ private static void LoadfieldValue(System.Reflection.FieldInfo field, bool isFieldAccessible, System.Type clazz)
{
/*
int MOD_EXPECTED = Modifier.PUBLIC | Modifier.STATIC;
Modified: incubator/lucene.net/trunk/src/core/QueryParser/CharStream.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/QueryParser/CharStream.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/QueryParser/CharStream.cs (original)
+++ incubator/lucene.net/trunk/src/core/QueryParser/CharStream.cs Sun Nov 6 05:24:26 2011
@@ -49,7 +49,7 @@ namespace Lucene.Net.QueryParsers
/// <summary> Returns the column position of the character last read.</summary>
/// <deprecated>
/// </deprecated>
- /// <seealso cref="getEndColumn">
+ /// <seealso cref="GetEndColumn">
/// </seealso>
[Obsolete]
int GetColumn();
@@ -57,7 +57,7 @@ namespace Lucene.Net.QueryParsers
/// <summary> Returns the line number of the character last read.</summary>
/// <deprecated>
/// </deprecated>
- /// <seealso cref="getEndLine">
+ /// <seealso cref="GetEndLine">
/// </seealso>
[Obsolete]
int GetLine();
Modified: incubator/lucene.net/trunk/src/core/QueryParser/FastCharStream.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/QueryParser/FastCharStream.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/QueryParser/FastCharStream.cs (original)
+++ incubator/lucene.net/trunk/src/core/QueryParser/FastCharStream.cs Sun Nov 6 05:24:26 2011
@@ -24,8 +24,8 @@ namespace Lucene.Net.QueryParsers
/// <summary>An efficient implementation of JavaCC's CharStream interface. <p/>Note that
/// this does not do line-number counting, but instead keeps track of the
- /// character position of the token in the input, as required by Lucene's {@link
- /// Lucene.Net.Analysis.Token} API.
+ /// character position of the token in the input, as required by Lucene's <see cref="Lucene.Net.Analysis.Token" />
+ /// API.
///
/// </summary>
public sealed class FastCharStream : CharStream
Modified: incubator/lucene.net/trunk/src/core/QueryParser/MultiFieldQueryParser.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/QueryParser/MultiFieldQueryParser.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/QueryParser/MultiFieldQueryParser.cs (original)
+++ incubator/lucene.net/trunk/src/core/QueryParser/MultiFieldQueryParser.cs Sun Nov 6 05:24:26 2011
@@ -44,7 +44,7 @@ namespace Lucene.Net.QueryParsers
/// <p/>
/// It will, when parse(String query) is called, construct a query like this
/// (assuming the query consists of two terms and you specify the two fields
- /// <code>title</code> and <code>body</code>):
+ /// <c>title</c> and <c>body</c>):
/// <p/>
///
/// <code>
@@ -74,7 +74,7 @@ namespace Lucene.Net.QueryParsers
///
/// </summary>
/// <deprecated> Please use
- /// {@link #MultiFieldQueryParser(Version, String[], Analyzer, Map)}
+ /// <see cref="MultiFieldQueryParser(Version, String[], Analyzer, System.Collections.IDictionary)" />
/// instead
/// </deprecated>
[Obsolete("Please use MultiFieldQueryParser(Version, String[], Analyzer, IDictionary) instead")]
@@ -89,7 +89,7 @@ namespace Lucene.Net.QueryParsers
/// <p/>
/// It will, when parse(String query) is called, construct a query like this
/// (assuming the query consists of two terms and you specify the two fields
- /// <code>title</code> and <code>body</code>):
+ /// <c>title</c> and <c>body</c>):
/// <p/>
///
/// <code>
@@ -127,7 +127,7 @@ namespace Lucene.Net.QueryParsers
/// <p/>
/// It will, when parse(String query) is called, construct a query like this
/// (assuming the query consists of two terms and you specify the two fields
- /// <code>title</code> and <code>body</code>):
+ /// <c>title</c> and <c>body</c>):
/// <p/>
///
/// <code>
@@ -149,7 +149,7 @@ namespace Lucene.Net.QueryParsers
///
/// </summary>
/// <deprecated> Please use
- /// {@link #MultiFieldQueryParser(Version, String[], Analyzer)}
+ /// <see cref="MultiFieldQueryParser(Version, String[], Analyzer)" />
/// instead
/// </deprecated>
[Obsolete("Please use MultiFieldQueryParser(Version, String[], Analyzer) instead")]
@@ -162,7 +162,7 @@ namespace Lucene.Net.QueryParsers
/// <p/>
/// It will, when parse(String query) is called, construct a query like this
/// (assuming the query consists of two terms and you specify the two fields
- /// <code>title</code> and <code>body</code>):
+ /// <c>title</c> and <c>body</c>):
/// <p/>
///
/// <code>
@@ -301,11 +301,9 @@ namespace Lucene.Net.QueryParsers
/// <p/>
/// If x fields are specified, this effectively constructs:
///
- /// <pre>
- /// <code>
+ /// <code>
/// (field1:query1) (field2:query2) (field3:query3)...(fieldx:queryx)
- /// </code>
- /// </pre>
+ /// </code>
///
/// </summary>
/// <param name="queries">Queries strings to parse
@@ -321,7 +319,7 @@ namespace Lucene.Net.QueryParsers
/// <summary> if the length of the queries array differs from the length of
/// the fields array
/// </summary>
- /// <deprecated> Use {@link #Parse(Version,String[],String[],Analyzer)}
+ /// <deprecated> Use <see cref="Parse(Version,String[],String[],Analyzer)" />
/// instead
/// </deprecated>
[Obsolete("Use Parse(Version,String[],String[],Analyzer) instead")]
@@ -334,11 +332,9 @@ namespace Lucene.Net.QueryParsers
/// <p/>
/// If x fields are specified, this effectively constructs:
///
- /// <pre>
- /// <code>
+ /// <code>
/// (field1:query1) (field2:query2) (field3:query3)...(fieldx:queryx)
- /// </code>
- /// </pre>
+ /// </code>
///
/// </summary>
/// <param name="matchVersion">Lucene version to match; this is passed through to
@@ -377,7 +373,7 @@ namespace Lucene.Net.QueryParsers
/// <summary> Parses a query, searching on the fields specified.
/// Use this if you need to specify certain fields as required,
/// and others as prohibited.
- /// <p/><pre>
+ /// <p/>
/// Usage:
/// <code>
/// String[] fields = {"filename", "contents", "description"};
@@ -386,14 +382,11 @@ namespace Lucene.Net.QueryParsers
/// BooleanClause.Occur.MUST_NOT};
/// MultiFieldQueryParser.parse("query", fields, flags, analyzer);
/// </code>
- /// </pre>
/// <p/>
/// The code above would construct a query:
- /// <pre>
/// <code>
/// (filename:query) +(contents:query) -(description:query)
/// </code>
- /// </pre>
///
/// </summary>
/// <param name="query">Query string to parse
@@ -409,7 +402,7 @@ namespace Lucene.Net.QueryParsers
/// <summary> from the length of the flags array
/// </summary>
/// <deprecated> Use
- /// {@link #Parse(Version, String, String[], BooleanClause.Occur[], Analyzer)}
+ /// <see cref="Parse(Version, String, String[], BooleanClause.Occur[], Analyzer)" />
/// instead
/// </deprecated>
[Obsolete("Use Parse(Version, String, String[], BooleanClause.Occur[], Analyzer) instead")]
@@ -421,25 +414,20 @@ namespace Lucene.Net.QueryParsers
/// <summary> Parses a query, searching on the fields specified. Use this if you need
/// to specify certain fields as required, and others as prohibited.
/// <p/>
- ///
- /// <pre>
- /// Usage:
- /// <code>
+ /// Uasge:
+ /// <code>
/// String[] fields = {"filename", "contents", "description"};
/// BooleanClause.Occur[] flags = {BooleanClause.Occur.SHOULD,
/// BooleanClause.Occur.MUST,
/// BooleanClause.Occur.MUST_NOT};
/// MultiFieldQueryParser.parse("query", fields, flags, analyzer);
- /// </code>
- /// </pre>
+ /// </code>
/// <p/>
/// The code above would construct a query:
///
- /// <pre>
- /// <code>
+ /// <code>
/// (filename:query) +(contents:query) -(description:query)
- /// </code>
- /// </pre>
+ /// </code>
///
/// </summary>
/// <param name="matchVersion">Lucene version to match; this is passed through to
@@ -480,7 +468,7 @@ namespace Lucene.Net.QueryParsers
/// <summary> Parses a query, searching on the fields specified.
/// Use this if you need to specify certain fields as required,
/// and others as prohibited.
- /// <p/><pre>
+ /// <p/>
/// Usage:
/// <code>
/// String[] query = {"query1", "query2", "query3"};
@@ -490,14 +478,11 @@ namespace Lucene.Net.QueryParsers
/// BooleanClause.Occur.MUST_NOT};
/// MultiFieldQueryParser.parse(query, fields, flags, analyzer);
/// </code>
- /// </pre>
/// <p/>
/// The code above would construct a query:
- /// <pre>
/// <code>
/// (filename:query1) +(contents:query2) -(description:query3)
/// </code>
- /// </pre>
///
/// </summary>
/// <param name="queries">Queries string to parse
@@ -513,7 +498,7 @@ namespace Lucene.Net.QueryParsers
/// <summary> and flags array differ
/// </summary>
/// <deprecated> Used
- /// {@link #Parse(Version, String[], String[], BooleanClause.Occur[], Analyzer)}
+ /// <see cref="Parse(Version, String[], String[], BooleanClause.Occur[], Analyzer)" />
/// instead
/// </deprecated>
[Obsolete("Use Parse(Version, String[], String[], BooleanClause.Occur[], Analyzer) instead")]
@@ -525,26 +510,21 @@ namespace Lucene.Net.QueryParsers
/// <summary> Parses a query, searching on the fields specified. Use this if you need
/// to specify certain fields as required, and others as prohibited.
/// <p/>
- ///
- /// <pre>
/// Usage:
- /// <code>
+ /// <code>
/// String[] query = {"query1", "query2", "query3"};
/// String[] fields = {"filename", "contents", "description"};
/// BooleanClause.Occur[] flags = {BooleanClause.Occur.SHOULD,
/// BooleanClause.Occur.MUST,
/// BooleanClause.Occur.MUST_NOT};
/// MultiFieldQueryParser.parse(query, fields, flags, analyzer);
- /// </code>
- /// </pre>
+ /// </code>
/// <p/>
/// The code above would construct a query:
///
- /// <pre>
- /// <code>
+ /// <code>
/// (filename:query1) +(contents:query2) -(description:query3)
- /// </code>
- /// </pre>
+ /// </code>
///
/// </summary>
/// <param name="matchVersion">Lucene version to match; this is passed through to