lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ccurr...@apache.org
Subject [Lucene.Net] svn commit: r1198132 [6/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...
Date Sun, 06 Nov 2011 05:24:44 GMT
Modified: incubator/lucene.net/trunk/src/core/Index/CheckIndex.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/CheckIndex.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/CheckIndex.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/CheckIndex.cs Sun Nov  6 05:24:26 2011
@@ -42,7 +42,7 @@ namespace Lucene.Net.Index
 	{
 		
 		/// <summary>Default PrintStream for all CheckIndex instances.</summary>
-		/// <deprecated> Use {@link #setInfoStream} per instance,
+		/// <deprecated> Use <see cref="SetInfoStream" /> per instance,
 		/// instead. 
 		/// </deprecated>
         [Obsolete("Use SetInfoStream per instance,instead.")]
@@ -51,7 +51,7 @@ namespace Lucene.Net.Index
 		private System.IO.StreamWriter infoStream;
 		private Directory dir;
 		
-		/// <summary> Returned from {@link #CheckIndex()} detailing the health and status of the index.
+		/// <summary> Returned from <see cref="CheckIndex_Renamed_Method()" /> detailing the health and status of the index.
 		/// 
 		/// <p/><b>WARNING</b>: this API is new and experimental and is
 		/// subject to suddenly change in the next release.
@@ -83,21 +83,21 @@ namespace Lucene.Net.Index
 			public System.String segmentFormat;
 			
 			/// <summary>Empty unless you passed specific segments list to check as optional 3rd argument.</summary>
-			/// <seealso cref="CheckIndex.CheckIndex(List)">
+			/// <seealso cref="CheckIndex.CheckIndex_Renamed_Method(System.Collections.IList)">
 			/// </seealso>
 			public System.Collections.IList segmentsChecked = new System.Collections.ArrayList();
 			
 			/// <summary>True if the index was created with a newer version of Lucene than the CheckIndex tool. </summary>
 			public bool toolOutOfDate;
 			
-			/// <summary>List of {@link SegmentInfoStatus} instances, detailing status of each segment. </summary>
+			/// <summary>List of <see cref="SegmentInfoStatus" /> instances, detailing status of each segment. </summary>
 			public System.Collections.IList segmentInfos = new System.Collections.ArrayList();
 			
 			/// <summary>Directory index is in. </summary>
 			public Directory dir;
 			
 			/// <summary> SegmentInfos instance containing only segments that
-			/// had no problems (this is used with the {@link CheckIndex#fixIndex} 
+			/// had no problems (this is used with the <see cref="CheckIndex.FixIndex" /> 
 			/// method to repair the index. 
 			/// </summary>
 			internal SegmentInfos newSegments;
@@ -108,8 +108,8 @@ namespace Lucene.Net.Index
 			/// <summary>How many bad segments were found. </summary>
 			public int numBadSegments;
 			
-			/// <summary>True if we checked only specific segments ({@link
-			/// #CheckIndex(List)}) was called with non-null
+			/// <summary>True if we checked only specific segments (<see cref="CheckIndex_Renamed_Method(System.Collections.IList)" />)
+			/// was called with non-null
 			/// argument). 
 			/// </summary>
 			public bool partial;
@@ -118,7 +118,7 @@ namespace Lucene.Net.Index
             public System.Collections.Generic.IDictionary<string, string> userData;
 			
 			/// <summary>Holds the status of each segment in the index.
-			/// See {@link #segmentInfos}.
+			/// See <see cref="SegmentInfos" />.
 			/// 
 			/// <p/><b>WARNING</b>: this API is new and experimental and is
 			/// subject to suddenly change in the next release.
@@ -178,7 +178,7 @@ namespace Lucene.Net.Index
 				/// <summary>True if at least one of the fields in this segment
 				/// does not omitTermFreqAndPositions.
 				/// </summary>
-				/// <seealso cref="AbstractField.setOmitTermFreqAndPositions">
+				/// <seealso cref="AbstractField.SetOmitTermFreqAndPositions">
 				/// </seealso>
 				public bool hasProx;
 
@@ -299,7 +299,7 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary>Returns true if index is clean, else false. </summary>
-		/// <deprecated> Please instantiate a CheckIndex and then use {@link #CheckIndex()} instead 
+        /// <deprecated> Please instantiate a CheckIndex and then use <see cref="CheckIndex_Renamed_Method()" /> instead 
 		/// </deprecated>
         [Obsolete("Please instantiate a CheckIndex and then use CheckIndex() instead")]
 		public static bool Check(Directory dir, bool doFix)
@@ -308,7 +308,7 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary>Returns true if index is clean, else false.</summary>
-		/// <deprecated> Please instantiate a CheckIndex and then use {@link #CheckIndex(List)} instead 
+        /// <deprecated> Please instantiate a CheckIndex and then use <see cref="CheckIndex_Renamed_Method(System.Collections.IList)" /> instead 
 		/// </deprecated>
         [Obsolete("Please instantiate a CheckIndex and then use CheckIndex(List) instead")]
 		public static bool Check(Directory dir, bool doFix, System.Collections.IList onlySegments)
@@ -321,7 +321,7 @@ namespace Lucene.Net.Index
 			return status.clean;
 		}
 		
-		/// <summary>Returns a {@link Status} instance detailing
+		/// <summary>Returns a <see cref="Status" /> instance detailing
 		/// the state of the index.
 		/// 
 		/// <p/>As this method checks every byte in the index, on a large
@@ -336,7 +336,7 @@ namespace Lucene.Net.Index
 			return CheckIndex_Renamed_Method(null);
 		}
 		
-		/// <summary>Returns a {@link Status} instance detailing
+		/// <summary>Returns a <see cref="Status" /> instance detailing
 		/// the state of the index.
 		/// 
 		/// </summary>
@@ -877,9 +877,9 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary>Repairs the index using previously returned result
-		/// from {@link #checkIndex}.  Note that this does not
+		/// from <see cref="CheckIndex" />.  Note that this does not
 		/// remove any of the unreferenced files after it's done;
-		/// you must separately open an {@link IndexWriter}, which
+		/// you must separately open an <see cref="IndexWriter" />, which
 		/// deletes unreferenced files when it's created.
 		/// 
 		/// <p/><b>WARNING</b>: this writes a
@@ -914,18 +914,18 @@ namespace Lucene.Net.Index
 		/// <summary>Command-line interface to check and fix an index.
 		/// <p/>
 		/// Run it like this:
-		/// <pre>
+        /// <code>
 		/// java -ea:Lucene.Net... Lucene.Net.Index.CheckIndex pathToIndex [-fix] [-segment X] [-segment Y]
-		/// </pre>
-		/// <ul>
-		/// <li><code>-fix</code>: actually write a new segments_N file, removing any problematic segments</li>
-		/// <li><code>-segment X</code>: only check the specified
+        /// </code>
+		/// <list type="bullet">
+		/// <item><c>-fix</c>: actually write a new segments_N file, removing any problematic segments</item>
+		/// <item><c>-segment X</c>: only check the specified
 		/// segment(s).  This can be specified multiple times,
-		/// to check more than one segment, eg <code>-segment _2
-		/// -segment _a</code>.  You can't use this with the -fix
-		/// option.</li>
-		/// </ul>
-		/// <p/><b>WARNING</b>: <code>-fix</code> should only be used on an emergency basis as it will cause
+		/// to check more than one segment, eg <c>-segment _2
+		/// -segment _a</c>.  You can't use this with the -fix
+		/// option.</item>
+		/// </list>
+		/// <p/><b>WARNING</b>: <c>-fix</c> should only be used on an emergency basis as it will cause
 		/// documents (perhaps many) to be permanently removed from the index.  Always make
 		/// a backup copy of your index before running this!  Do not run this tool on an index
 		/// that is actively being written to.  You have been warned!

Modified: incubator/lucene.net/trunk/src/core/Index/CompoundFileReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/CompoundFileReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/CompoundFileReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/CompoundFileReader.cs Sun Nov  6 05:24:26 2011
@@ -285,7 +285,7 @@ namespace Lucene.Net.Index
 			}
 			
 			/// <summary>Expert: implements seek.  Sets current position in this file, where
-			/// the next {@link #ReadInternal(byte[],int,int)} will occur.
+			/// the next <see cref="ReadInternal(byte[],int,int)" /> will occur.
 			/// </summary>
 			/// <seealso cref="ReadInternal(byte[],int,int)">
 			/// </seealso>

Modified: incubator/lucene.net/trunk/src/core/Index/CompoundFileWriter.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/CompoundFileWriter.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/CompoundFileWriter.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/CompoundFileWriter.cs Sun Nov  6 05:24:26 2011
@@ -27,17 +27,17 @@ namespace Lucene.Net.Index
 	
 	/// <summary> Combines multiple files into a single compound file.
 	/// The file format:<br/>
-	/// <ul>
-	/// <li>VInt fileCount</li>
-	/// <li>{Directory}
-	/// fileCount entries with the following structure:</li>
-	/// <ul>
-	/// <li>long dataOffset</li>
-	/// <li>String fileName</li>
-	/// </ul>
-	/// <li>{File Data}
-	/// fileCount entries with the raw data of the corresponding file</li>
-	/// </ul>
+	/// <list type="bullet">
+	/// <item>VInt fileCount</item>
+	/// <item>{Directory}
+	/// fileCount entries with the following structure:</item>
+	/// <list type="bullet">
+	/// <item>long dataOffset</item>
+	/// <item>String fileName</item>
+	/// </list>
+	/// <item>{File Data}
+	/// fileCount entries with the raw data of the corresponding file</item>
+	/// </list>
 	/// 
 	/// The fileCount integer indicates how many files are contained in this compound
 	/// file. The {directory} that follows has that many entries. Each directory entry
@@ -74,7 +74,7 @@ namespace Lucene.Net.Index
 		/// <summary>Create the compound stream in the specified file. The file name is the
 		/// entire name (no extensions are added).
 		/// </summary>
-		/// <throws>  NullPointerException if <code>dir</code> or <code>name</code> is null </throws>
+		/// <throws>  NullPointerException if <c>dir</c> or <c>name</c> is null </throws>
 		public CompoundFileWriter(Directory dir, System.String name):this(dir, name, null)
 		{
 		}
@@ -104,12 +104,12 @@ namespace Lucene.Net.Index
 			return fileName;
 		}
 		
-		/// <summary>Add a source stream. <code>file</code> is the string by which the 
+		/// <summary>Add a source stream. <c>file</c> is the string by which the 
 		/// sub-stream will be known in the compound stream.
 		/// 
 		/// </summary>
 		/// <throws>  IllegalStateException if this writer is closed </throws>
-		/// <throws>  NullPointerException if <code>file</code> is null </throws>
+		/// <throws>  NullPointerException if <c>file</c> is null </throws>
 		/// <throws>  IllegalArgumentException if a file with the same name </throws>
 		/// <summary>   has been added already
 		/// </summary>

Modified: incubator/lucene.net/trunk/src/core/Index/ConcurrentMergeScheduler.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/ConcurrentMergeScheduler.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/ConcurrentMergeScheduler.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/ConcurrentMergeScheduler.cs Sun Nov  6 05:24:26 2011
@@ -22,9 +22,9 @@ using Directory = Lucene.Net.Store.Direc
 namespace Lucene.Net.Index
 {
 	
-	/// <summary>A {@link MergeScheduler} that runs each merge using a
+	/// <summary>A <see cref="MergeScheduler" /> that runs each merge using a
 	/// separate thread, up until a maximum number of threads
-	/// ({@link #setMaxThreadCount}) at which when a merge is
+	/// (<see cref="SetMaxThreadCount" />) at which when a merge is
 	/// needed, the thread(s) that are updating the index will
 	/// pause until one or more merges completes.  This is a
 	/// simple way to use concurrency in the indexing process
@@ -71,7 +71,7 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary>Get the max # simultaneous threads that may be</summary>
-		/// <seealso cref="setMaxThreadCount">
+		/// <seealso cref="SetMaxThreadCount">
 		/// </seealso>
 		public virtual int GetMaxThreadCount()
 		{
@@ -295,7 +295,7 @@ namespace Lucene.Net.Index
 			}
 		}
 		
-		/// <summary>Does the actual merge, by calling {@link IndexWriter#merge} </summary>
+		/// <summary>Does the actual merge, by calling <see cref="IndexWriter.Merge" /> </summary>
 		protected internal virtual void  DoMerge(MergePolicy.OneMerge merge)
 		{
 			writer.Merge(merge);

Modified: incubator/lucene.net/trunk/src/core/Index/DefaultSkipListReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/DefaultSkipListReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/DefaultSkipListReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/DefaultSkipListReader.cs Sun Nov  6 05:24:26 2011
@@ -58,7 +58,7 @@ namespace Lucene.Net.Index
         }
 		
 		/// <summary>Returns the freq pointer of the doc to which the last call of 
-		/// {@link MultiLevelSkipListReader#SkipTo(int)} has skipped.  
+		/// <see cref="MultiLevelSkipListReader.SkipTo(int)" /> has skipped.  
 		/// </summary>
 		internal virtual long GetFreqPointer()
 		{
@@ -66,7 +66,7 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary>Returns the prox pointer of the doc to which the last call of 
-		/// {@link MultiLevelSkipListReader#SkipTo(int)} has skipped.  
+		/// <see cref="MultiLevelSkipListReader.SkipTo(int)" /> has skipped.  
 		/// </summary>
 		internal virtual long GetProxPointer()
 		{
@@ -74,7 +74,7 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary>Returns the payload length of the payload stored just before 
-		/// the doc to which the last call of {@link MultiLevelSkipListReader#SkipTo(int)} 
+		/// the doc to which the last call of <see cref="MultiLevelSkipListReader.SkipTo(int)" /> 
 		/// has skipped.  
 		/// </summary>
 		internal virtual int GetPayloadLength()

Modified: incubator/lucene.net/trunk/src/core/Index/DirectoryOwningReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/DirectoryOwningReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/DirectoryOwningReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/DirectoryOwningReader.cs Sun Nov  6 05:24:26 2011
@@ -114,7 +114,7 @@ namespace Lucene.Net.Index
 		
 		/// <summary> This member contains the ref counter, that is passed to each instance after cloning/reopening,
 		/// and is global to all DirectoryOwningReader derived from the original one.
-		/// This reuses the class {@link SegmentReader.Ref}
+		/// This reuses the class <see cref="SegmentReader.Ref" />
 		/// </summary>
 		private SegmentReader.Ref ref_Renamed;
 	}

Modified: incubator/lucene.net/trunk/src/core/Index/DirectoryReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/DirectoryReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/DirectoryReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/DirectoryReader.cs Sun Nov  6 05:24:26 2011
@@ -237,7 +237,7 @@ namespace Lucene.Net.Index
 			Initialize(readers);
 		}
 		
-		/// <summary>This constructor is only used for {@link #Reopen()} </summary>
+		/// <summary>This constructor is only used for <see cref="Reopen()" /> </summary>
 		internal DirectoryReader(Directory directory, SegmentInfos infos, SegmentReader[] oldReaders, int[] oldStarts, System.Collections.IDictionary oldNormsCache, bool readOnly, bool doClone, int termInfosIndexDivisor)
 		{
 			this.directory = directory;
@@ -648,7 +648,7 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary> Checks is the index is optimized (if it has a single segment and no deletions)</summary>
-		/// <returns> <code>true</code> if the index is optimized; <code>false</code> otherwise
+		/// <returns> <c>true</c> if the index is optimized; <c>false</c> otherwise
 		/// </returns>
 		public override bool IsOptimized()
 		{
@@ -865,7 +865,7 @@ namespace Lucene.Net.Index
 		/// <throws>  StaleReaderException  if the index has changed since this reader was opened </throws>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  Lucene.Net.Store.LockObtainFailedException </throws>
-		/// <summary>                               if another writer has this index open (<code>write.lock</code> could not be
+		/// <summary>                               if another writer has this index open (<c>write.lock</c> could not be
 		/// obtained)
 		/// </summary>
 		/// <throws>  IOException           if there is a low-level IO error </throws>
@@ -1120,7 +1120,7 @@ namespace Lucene.Net.Index
 			return new ReaderCommit(segmentInfos, directory);
 		}
 		
-		/// <seealso cref="Lucene.Net.Index.IndexReader.listCommits">
+		/// <seealso cref="Lucene.Net.Index.IndexReader.ListCommits">
 		/// </seealso>
 		public static new System.Collections.ICollection ListCommits(Directory dir)
 		{

Modified: incubator/lucene.net/trunk/src/core/Index/DocumentsWriter.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/DocumentsWriter.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/DocumentsWriter.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/DocumentsWriter.cs Sun Nov  6 05:24:26 2011
@@ -38,17 +38,17 @@ namespace Lucene.Net.Index
 	/// (with DocumentWriter) and doing standard merges on those
 	/// segments.
 	/// 
-	/// Each added document is passed to the {@link DocConsumer},
+	/// Each added document is passed to the <see cref="DocConsumer" />,
 	/// which in turn processes the document and interacts with
 	/// other consumers in the indexing chain.  Certain
-	/// consumers, like {@link StoredFieldsWriter} and {@link
-	/// TermVectorsTermsWriter}, digest a document and
+	/// consumers, like <see cref="StoredFieldsWriter" /> and <see cref="TermVectorsTermsWriter" />
+	///, digest a document and
 	/// immediately write bytes to the "doc store" files (ie,
 	/// they do not consume RAM per document, except while they
 	/// are processing the document).
 	/// 
-	/// Other consumers, eg {@link FreqProxTermsWriter} and
-	/// {@link NormsWriter}, buffer bytes in RAM and flush only
+	/// Other consumers, eg <see cref="FreqProxTermsWriter" /> and
+	/// <see cref="NormsWriter" />, buffer bytes in RAM and flush only
 	/// when a new segment is produced.
 	/// Once we have used our allowed RAM buffer, or the number
 	/// of added docs is large enough (in the case we are
@@ -278,7 +278,7 @@ namespace Lucene.Net.Index
             }
         }
 
-		/// <summary> The IndexingChain must define the {@link #GetChain(DocumentsWriter)} method
+		/// <summary> The IndexingChain must define the <see cref="GetChain(DocumentsWriter)" /> method
 		/// which returns the DocConsumer that the DocumentsWriter calls to process the
 		/// documents. 
 		/// </summary>

Modified: incubator/lucene.net/trunk/src/core/Index/FieldInfos.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/FieldInfos.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/FieldInfos.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/FieldInfos.cs Sun Nov  6 05:24:26 2011
@@ -190,7 +190,7 @@ namespace Lucene.Net.Index
 		/// <param name="isIndexed">Whether the fields are indexed or not
 		/// 
 		/// </param>
-		/// <seealso cref="Add(String, boolean)">
+		/// <seealso cref="Add(String, bool)">
 		/// </seealso>
         public void Add(System.Collections.Generic.ICollection<string> names, bool isIndexed)
 		{
@@ -211,7 +211,7 @@ namespace Lucene.Net.Index
 		/// </param>
 		/// <param name="isIndexed">true if the field is indexed
 		/// </param>
-		/// <seealso cref="Add(String, boolean, boolean, boolean, boolean)">
+        /// <seealso cref="Add(String, bool, bool, bool, bool)">
 		/// </seealso>
 		public void  Add(System.String name, bool isIndexed)
 		{

Modified: incubator/lucene.net/trunk/src/core/Index/FieldInvertState.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/FieldInvertState.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/FieldInvertState.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/FieldInvertState.cs Sun Nov  6 05:24:26 2011
@@ -80,7 +80,7 @@ namespace Lucene.Net.Index
 			return length;
 		}
 		
-		/// <summary> Get the number of terms with <code>positionIncrement == 0</code>.</summary>
+		/// <summary> Get the number of terms with <c>positionIncrement == 0</c>.</summary>
 		/// <returns> the numOverlap
 		/// </returns>
 		public int GetNumOverlap()

Modified: incubator/lucene.net/trunk/src/core/Index/FieldReaderException.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/FieldReaderException.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/FieldReaderException.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/FieldReaderException.cs Sun Nov  6 05:24:26 2011
@@ -27,9 +27,9 @@ namespace Lucene.Net.Index
 	[Serializable]
 	public class FieldReaderException:System.SystemException
 	{
-		/// <summary> Constructs a new runtime exception with <code>null</code> as its
+		/// <summary> Constructs a new runtime exception with <c>null</c> as its
 		/// detail message.  The cause is not initialized, and may subsequently be
-        /// initialized by a call to {@link #innerException}.
+        /// initialized by a call to <see cref="Exception.InnerException" />.
 		/// </summary>
 		public FieldReaderException()
 		{
@@ -45,7 +45,7 @@ namespace Lucene.Net.Index
 		/// 
 		/// </summary>
 		/// <param name="cause">the cause (which is saved for later retrieval by the
-		/// {@link #InnerException()} method).  (A <tt>null</tt> value is
+        /// <see cref="Exception.InnerException" />).  (A <tt>null</tt> value is
 		/// permitted, and indicates that the cause is nonexistent or
 		/// unknown.)
 		/// </param>
@@ -57,11 +57,11 @@ namespace Lucene.Net.Index
 		
 		/// <summary> Constructs a new runtime exception with the specified detail message.
 		/// The cause is not initialized, and may subsequently be initialized by a
-        /// call to {@link #innerException}.
+        /// call to <see cref="Exception.InnerException" />.
 		/// 
 		/// </summary>
 		/// <param name="message">the detail message. The detail message is saved for
-		/// later retrieval by the {@link #getMessage()} method.
+        /// later retrieval by the <see cref="Exception.Message" /> method.
 		/// </param>
 		public FieldReaderException(System.String message):base(message)
 		{
@@ -69,15 +69,15 @@ namespace Lucene.Net.Index
 		
 		/// <summary> Constructs a new runtime exception with the specified detail message and
 		/// cause.  <p/>Note that the detail message associated with
-		/// <code>cause</code> is <i>not</i> automatically incorporated in
+		/// <c>cause</c> is <i>not</i> automatically incorporated in
 		/// this runtime exception's detail message.
 		/// 
 		/// </summary>
 		/// <param name="message">the detail message (which is saved for later retrieval
-		/// by the {@link #getMessage()} method).
+        /// by the <see cref="Exception.Message" /> method).
 		/// </param>
 		/// <param name="cause">  the cause (which is saved for later retrieval by the
-		/// {@link #InnerException()} method).  (A <tt>null</tt> value is
+        /// <see cref="Exception.InnerException" /> method).  (A <tt>null</tt> value is
 		/// permitted, and indicates that the cause is nonexistent or
 		/// unknown.)
 		/// </param>

Modified: incubator/lucene.net/trunk/src/core/Index/FieldSortedTermVectorMapper.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/FieldSortedTermVectorMapper.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/FieldSortedTermVectorMapper.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/FieldSortedTermVectorMapper.cs Sun Nov  6 05:24:26 2011
@@ -20,7 +20,7 @@ using System;
 namespace Lucene.Net.Index
 {
 	
-	/// <summary> For each Field, store a sorted collection of {@link TermVectorEntry}s
+	/// <summary> For each Field, store a sorted collection of <see cref="TermVectorEntry" />s
 	/// <p/>
 	/// This is not thread-safe.
 	/// </summary>
@@ -32,7 +32,7 @@ namespace Lucene.Net.Index
 		private System.Collections.Generic.IComparer<object> comparator;
 		
 		/// <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 FieldSortedTermVectorMapper(System.Collections.Generic.IComparer<object> comparator):this(false, false, comparator)
 		{
@@ -60,7 +60,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 {@link java.util.SortedSet}s per field.  SortedSet entries are {@link TermVectorEntry}
+        /// <returns> A map between field names and <see cref="System.Collections.Generic.SortedDictionary{Object,Object}" />s per field.  SortedSet entries are <see cref="TermVectorEntry" />
 		/// </returns>
 		public virtual System.Collections.IDictionary GetFieldToTerms()
 		{

Modified: incubator/lucene.net/trunk/src/core/Index/FieldsReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/FieldsReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/FieldsReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/FieldsReader.cs Sun Nov  6 05:24:26 2011
@@ -177,7 +177,7 @@ namespace Lucene.Net.Index
 			}
 		}
 		
-		/// <summary> Closes the underlying {@link Lucene.Net.Store.IndexInput} streams, including any ones associated with a
+		/// <summary> Closes the underlying <see cref="Lucene.Net.Store.IndexInput" /> streams, including any ones associated with a
 		/// lazy implementation of a Field.  This means that the Fields values will not be accessible.
 		/// 
 		/// </summary>

Modified: incubator/lucene.net/trunk/src/core/Index/FilterIndexReader.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/FilterIndexReader.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/FilterIndexReader.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/FilterIndexReader.cs Sun Nov  6 05:24:26 2011
@@ -24,19 +24,19 @@ using Directory = Lucene.Net.Store.Direc
 namespace Lucene.Net.Index
 {
 	
-	/// <summary>A <code>FilterIndexReader</code> contains another IndexReader, which it
+	/// <summary>A <c>FilterIndexReader</c> contains another IndexReader, which it
 	/// uses as its basic source of data, possibly transforming the data along the
 	/// way or providing additional functionality. The class
-	/// <code>FilterIndexReader</code> itself simply implements all abstract methods
-	/// of <code>IndexReader</code> with versions that pass all requests to the
-	/// contained index reader. Subclasses of <code>FilterIndexReader</code> may
+	/// <c>FilterIndexReader</c> itself simply implements all abstract methods
+	/// of <c>IndexReader</c> with versions that pass all requests to the
+	/// contained index reader. Subclasses of <c>FilterIndexReader</c> may
 	/// further override some of these methods and may also provide additional
 	/// methods and fields.
 	/// </summary>
 	public class FilterIndexReader:IndexReader
 	{
-		
-		/// <summary>Base class for filtering {@link TermDocs} implementations. </summary>
+
+        /// <summary>Base class for filtering <see cref="Lucene.Net.Index.TermDocs" /> implementations. </summary>
 		public class FilterTermDocs : TermDocs
 		{
 			protected internal TermDocs in_Renamed;
@@ -80,7 +80,7 @@ namespace Lucene.Net.Index
 			}
 		}
 		
-		/// <summary>Base class for filtering {@link TermPositions} implementations. </summary>
+		/// <summary>Base class for filtering <see cref="TermPositions" /> implementations. </summary>
 		public class FilterTermPositions:FilterTermDocs, TermPositions
 		{
 			
@@ -111,7 +111,7 @@ namespace Lucene.Net.Index
 			}
 		}
 		
-		/// <summary>Base class for filtering {@link TermEnum} implementations. </summary>
+		/// <summary>Base class for filtering <see cref="TermEnum" /> implementations. </summary>
 		public class FilterTermEnum:TermEnum
 		{
 			protected internal TermEnum in_Renamed;
@@ -146,7 +146,7 @@ namespace Lucene.Net.Index
 		/// left to the base reader.<p/>
 		/// <p/>Note that base reader is closed if this FilterIndexReader is closed.<p/>
 		/// </summary>
-		/// <param name="in">specified base reader.
+		///  <param name="in_Renamed">specified base reader.
 		/// </param>
 		public FilterIndexReader(IndexReader in_Renamed):base()
 		{

Modified: incubator/lucene.net/trunk/src/core/Index/FormatPostingsDocsWriter.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/FormatPostingsDocsWriter.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/FormatPostingsDocsWriter.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/FormatPostingsDocsWriter.cs Sun Nov  6 05:24:26 2011
@@ -15,18 +15,15 @@
  * limitations under the License.
  */
 
-
-/// <summary>Consumes doc & freq, writing them using the current
-/// index file format 
-/// </summary>
-
 using System;
 using IndexOutput = Lucene.Net.Store.IndexOutput;
 using UnicodeUtil = Lucene.Net.Util.UnicodeUtil;
 
 namespace Lucene.Net.Index
 {
-	
+    /// <summary>Consumes doc and freq, writing them using the current
+    /// index file format 
+    /// </summary>
 	sealed class FormatPostingsDocsWriter:FormatPostingsDocsConsumer
 	{
 		

Modified: incubator/lucene.net/trunk/src/core/Index/IndexCommit.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/IndexCommit.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/IndexCommit.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/IndexCommit.cs Sun Nov  6 05:24:26 2011
@@ -23,12 +23,12 @@ namespace Lucene.Net.Index
 {
 	
 	/// <summary> <p/>Expert: represents a single commit into an index as seen by the
-	/// {@link IndexDeletionPolicy} or {@link IndexReader}.<p/>
+	/// <see cref="IndexDeletionPolicy" /> or <see cref="IndexReader" />.<p/>
 	/// 
 	/// <p/> Changes to the content of an index are made visible
 	/// only after the writer who made that change commits by
 	/// writing a new segments file
-	/// (<code>segments_N</code>). This point in time, when the
+	/// (<c>segments_N</c>). This point in time, when the
 	/// action of writing of a new segments file to the directory
 	/// is completed, is an index commit.<p/>
 	/// 
@@ -43,7 +43,7 @@ namespace Lucene.Net.Index
 	public abstract class IndexCommit : IndexCommitPoint
 	{
 		
-		/// <summary> Get the segments file (<code>segments_N</code>) associated 
+		/// <summary> Get the segments file (<c>segments_N</c>) associated 
 		/// with this commit point.
 		/// </summary>
 		public abstract System.String GetSegmentsFileName();
@@ -51,7 +51,7 @@ namespace Lucene.Net.Index
 		/// <summary> Returns all index files referenced by this commit point.</summary>
 		public abstract System.Collections.Generic.ICollection<string> GetFileNames();
 		
-		/// <summary> Returns the {@link Directory} for the index.</summary>
+		/// <summary> Returns the <see cref="Directory" /> for the index.</summary>
 		public abstract Directory GetDirectory();
 		
 		/// <summary> Delete this commit point.  This only applies when using
@@ -61,9 +61,9 @@ namespace Lucene.Net.Index
 		/// Upon calling this, the writer is notified that this commit 
 		/// point should be deleted. 
 		/// <p/>
-		/// Decision that a commit-point should be deleted is taken by the {@link IndexDeletionPolicy} in effect
-		/// and therefore this should only be called by its {@link IndexDeletionPolicy#onInit onInit()} or 
-		/// {@link IndexDeletionPolicy#onCommit onCommit()} methods.
+		/// Decision that a commit-point should be deleted is taken by the <see cref="IndexDeletionPolicy" /> in effect
+        /// and therefore this should only be called by its <see cref="IndexDeletionPolicy.OnInit(System.Collections.IList)" /> or 
+        /// <see cref="IndexDeletionPolicy.OnCommit(System.Collections.IList)" /> methods.
 		/// </summary>
         public abstract void Delete();
 
@@ -90,7 +90,7 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary>Returns the version for this IndexCommit.  This is the
-		/// same value that {@link IndexReader#getVersion} would
+		/// same value that <see cref="IndexReader.GetVersion" /> would
 		/// return if it were opened on this commit. 
 		/// </summary>
         public abstract long GetVersion();
@@ -109,10 +109,10 @@ namespace Lucene.Net.Index
 		{
 			return GetDirectory().FileModified(GetSegmentsFileName());
 		}
-		
-		/// <summary>Returns userData, previously passed to {@link
-		/// IndexWriter#Commit(Map)} for this commit.  Map is
-		/// String -> String. 
+
+        /// <summary>Returns userData, previously passed to 
+        /// <see cref="IndexWriter.Commit(System.Collections.Generic.IDictionary{string, string})" />
+		/// for this commit.  IDictionary is String -> String. 
 		/// </summary>
         public abstract System.Collections.Generic.IDictionary<string, string> GetUserData();
 	}

Modified: incubator/lucene.net/trunk/src/core/Index/IndexCommitPoint.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/IndexCommitPoint.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/IndexCommitPoint.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/IndexCommitPoint.cs Sun Nov  6 05:24:26 2011
@@ -26,7 +26,7 @@ namespace Lucene.Net.Index
 	public interface IndexCommitPoint
 	{
 		
-		/// <summary> Get the segments file (<code>segments_N</code>) associated 
+		/// <summary> Get the segments file (<c>segments_N</c>) associated 
 		/// with this commit point.
 		/// </summary>
 		System.String GetSegmentsFileName();
@@ -39,9 +39,9 @@ namespace Lucene.Net.Index
 		/// Upon calling this, the writer is notified that this commit 
 		/// point should be deleted. 
 		/// <p/>
-		/// Decision that a commit-point should be deleted is taken by the {@link IndexDeletionPolicy} in effect
-		/// and therefore this should only be called by its {@link IndexDeletionPolicy#onInit onInit()} or 
-		/// {@link IndexDeletionPolicy#onCommit onCommit()} methods.
+		/// Decision that a commit-point should be deleted is taken by the <see cref="IndexDeletionPolicy" /> in effect
+        /// and therefore this should only be called by its <see cref="IndexDeletionPolicy.OnInit(System.Collections.IList)" /> or 
+        /// <see cref="IndexDeletionPolicy.OnCommit(System.Collections.IList)" /> methods.
 		/// </summary>
 		void  Delete();
 	}

Modified: incubator/lucene.net/trunk/src/core/Index/IndexDeletionPolicy.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/IndexDeletionPolicy.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/IndexDeletionPolicy.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/IndexDeletionPolicy.cs Sun Nov  6 05:24:26 2011
@@ -20,14 +20,14 @@ using System;
 namespace Lucene.Net.Index
 {
 	
-	/// <summary> <p/>Expert: policy for deletion of stale {@link IndexCommit index commits}. 
+	/// <summary> <p/>Expert: policy for deletion of stale <see cref="IndexCommit">index commits</see>. 
 	/// 
 	/// <p/>Implement this interface, and pass it to one
-	/// of the {@link IndexWriter} or {@link IndexReader}
+	/// of the <see cref="IndexWriter" /> or <see cref="IndexReader" />
 	/// constructors, to customize when older
-	/// {@link IndexCommit point-in-time commits}
+	/// <see cref="IndexCommit">point-in-time commits</see>
 	/// are deleted from the index directory.  The default deletion policy
-	/// is {@link KeepOnlyLastCommitDeletionPolicy}, which always
+	/// is <see cref="KeepOnlyLastCommitDeletionPolicy" />, which always
 	/// removes old commits as soon as a new commit is done (this
 	/// matches the behavior before 2.2).<p/>
 	/// 
@@ -39,7 +39,7 @@ namespace Lucene.Net.Index
 	/// By implementing a custom deletion policy, such as "a
 	/// commit is only removed once it has been stale for more
 	/// than X minutes", you can give your readers time to
-	/// refresh to the new commit before {@link IndexWriter}
+	/// refresh to the new commit before <see cref="IndexWriter" />
 	/// removes the old commits.  Note that doing so will
 	/// increase the storage requirements of the index.  See <a
 	/// target="top"
@@ -57,8 +57,8 @@ namespace Lucene.Net.Index
 		/// <p/>The writer locates all index commits present in the 
 		/// index directory and calls this method.  The policy may 
 		/// choose to delete some of the commit points, doing so by
-		/// calling method {@link IndexCommit#delete delete()} 
-		/// of {@link IndexCommit}.<p/>
+		/// calling method <see cref="IndexCommit.Delete()" /> 
+		/// of <see cref="IndexCommit" />.<p/>
 		/// 
 		/// <p/><u>Note:</u> the last CommitPoint is the most recent one,
 		/// i.e. the "front index state". Be careful not to delete it,
@@ -67,7 +67,7 @@ namespace Lucene.Net.Index
 		/// 
 		/// </summary>
 		/// <param name="commits">List of current 
-		/// {@link IndexCommit point-in-time commits},
+		/// <see cref="IndexCommit">point-in-time commits</see>,
 		/// sorted by age (the 0th one is the oldest commit).
 		/// </param>
 		void  OnInit(System.Collections.IList commits);
@@ -77,15 +77,15 @@ namespace Lucene.Net.Index
 		/// with each commit.<p/>
 		/// 
 		/// <p/>The policy may now choose to delete old commit points 
-		/// by calling method {@link IndexCommit#delete delete()} 
-		/// of {@link IndexCommit}.<p/>
+		/// by calling method <see cref="IndexCommit.Delete()" /> 
+		/// of <see cref="IndexCommit" />.<p/>
 		/// 
-		/// <p/>If writer has <code>autoCommit = true</code> then
+		/// <p/>If writer has <c>autoCommit = true</c> then
 		/// this method will in general be called many times during
-		/// one instance of {@link IndexWriter}.  If
-		/// <code>autoCommit = false</code> then this method is
-		/// only called once when {@link IndexWriter#close} is
-		/// called, or not at all if the {@link IndexWriter#abort}
+		/// one instance of <see cref="IndexWriter" />.  If
+		/// <c>autoCommit = false</c> then this method is
+		/// only called once when <see cref="IndexWriter.Close()" /> is
+		/// called, or not at all if the <see cref="IndexWriter.Abort" />
 		/// is called. 
 		/// 
 		/// <p/><u>Note:</u> the last CommitPoint is the most recent one,
@@ -94,7 +94,7 @@ namespace Lucene.Net.Index
 		/// you can afford to lose the index content while doing that.
 		/// 
 		/// </summary>
-		/// <param name="commits">List of {@link IndexCommit},
+		/// <param name="commits">List of <see cref="IndexCommit" />,
 		/// sorted by age (the 0th one is the oldest commit).
 		/// </param>
 		void  OnCommit(System.Collections.IList commits);

Modified: incubator/lucene.net/trunk/src/core/Index/IndexFileDeleter.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/IndexFileDeleter.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/IndexFileDeleter.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/IndexFileDeleter.cs Sun Nov  6 05:24:26 2011
@@ -1,19 +1,19 @@
-/* 
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements.  See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License.  You may obtain a copy of the License at
- * 
- * http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+/*
+* Licensed to the Apache Software Foundation (ASF) under one or more
+* contributor license agreements.  See the NOTICE file distributed with
+* this work for additional information regarding copyright ownership.
+* The ASF licenses this file to You under the Apache License, Version 2.0
+* (the "License"); you may not use this file except in compliance with
+* the License.  You may obtain a copy of the License at
+* 
+* http://www.apache.org/licenses/LICENSE-2.0
+* 
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
 
 using System;
 
@@ -21,76 +21,76 @@ using Directory = Lucene.Net.Store.Direc
 
 namespace Lucene.Net.Index
 {
-	
-	/*
-	* This class keeps track of each SegmentInfos instance that
-	* is still "live", either because it corresponds to a
-	* segments_N file in the Directory (a "commit", i.e. a
-	* committed SegmentInfos) or because it's an in-memory
-	* SegmentInfos that a writer is actively updating but has
-	* not yet committed.  This class uses simple reference
-	* counting to map the live SegmentInfos instances to
-	* individual files in the Directory.
-	*
-	* When autoCommit=true, IndexWriter currently commits only
-	* on completion of a merge (though this may change with
-	* time: it is not a guarantee).  When autoCommit=false,
-	* IndexWriter only commits when it is closed.  Regardless
-	* of autoCommit, the user may call IndexWriter.commit() to
-	* force a blocking commit.
-	* 
-	* The same directory file may be referenced by more than
-	* one IndexCommit, i.e. more than one SegmentInfos.
-	* Therefore we count how many commits reference each file.
-	* When all the commits referencing a certain file have been
-	* deleted, the refcount for that file becomes zero, and the
-	* file is deleted.
-	*
-	* A separate deletion policy interface
-	* (IndexDeletionPolicy) is consulted on creation (onInit)
-	* and once per commit (onCommit), to decide when a commit
-	* should be removed.
-	* 
-	* It is the business of the IndexDeletionPolicy to choose
-	* when to delete commit points.  The actual mechanics of
-	* file deletion, retrying, etc, derived from the deletion
-	* of commit points is the business of the IndexFileDeleter.
-	* 
-	* The current default deletion policy is {@link
-	* KeepOnlyLastCommitDeletionPolicy}, which removes all
-	* prior commits when a new commit has completed.  This
-	* matches the behavior before 2.2.
-	*
-	* Note that you must hold the write.lock before
-	* instantiating this class.  It opens segments_N file(s)
-	* directly with no retry logic.
-	*/
+
+    /// <summary>
+    /// <para>This class keeps track of each SegmentInfos instance that
+    /// is still "live", either because it corresponds to a
+    /// segments_N file in the Directory (a "commit", i.e. a
+    /// committed SegmentInfos) or because it's an in-memory
+    /// SegmentInfos that a writer is actively updating but has
+    /// not yet committed.  This class uses simple reference
+    /// counting to map the live SegmentInfos instances to
+    /// individual files in the Directory.</para>
+    ///
+    /// <para>When autoCommit=true, IndexWriter currently commits only
+    /// on completion of a merge (though this may change with
+    /// time: it is not a guarantee).  When autoCommit=false,
+    /// IndexWriter only commits when it is closed.  Regardless
+    /// of autoCommit, the user may call IndexWriter.commit() to
+    /// force a blocking commit.</para>
+    /// 
+    /// <para>The same directory file may be referenced by more than
+    /// one IndexCommit, i.e. more than one SegmentInfos.
+    /// Therefore we count how many commits reference each file.
+    /// When all the commits referencing a certain file have been
+    /// deleted, the refcount for that file becomes zero, and the
+    /// file is deleted.</para>
+    ///
+    /// <para>A separate deletion policy interface
+    /// (IndexDeletionPolicy) is consulted on creation (onInit)
+    /// and once per commit (onCommit), to decide when a commit
+    /// should be removed.</para>
+    /// 
+    /// <para>It is the business of the IndexDeletionPolicy to choose
+    /// when to delete commit points.  The actual mechanics of
+    /// file deletion, retrying, etc, derived from the deletion
+    /// of commit points is the business of the IndexFileDeleter.</para>
+    /// 
+    /// <para>The current default deletion policy is
+    /// <see cref="KeepOnlyLastCommitDeletionPolicy"/>, which removes all
+    /// prior commits when a new commit has completed.  This
+    /// matches the behavior before 2.2.</para>
+    ///
+    /// <para>Note that you must hold the write.lock before
+    /// instantiating this class.  It opens segments_N file(s)
+    /// directly with no retry logic.</para>
+    /// </summary>
 	
 	public sealed class IndexFileDeleter
 	{
 		
-		/* Files that we tried to delete but failed (likely
-		* because they are open and we are running on Windows),
-		* so we will retry them again later: */
+		//// Files that we tried to delete but failed (likely
+		/// because they are open and we are running on Windows),
+		/// so we will retry them again later: ////
 		private System.Collections.Generic.IList<string> deletable;
 		
-		/* Reference count for all files in the index.  
-		* Counts how many existing commits reference a file.
-		* Maps String to RefCount (class below) instances: */
+		//// Reference count for all files in the index.  
+		/// Counts how many existing commits reference a file.
+		/// Maps String to RefCount (class below) instances: ////
 		private System.Collections.Generic.Dictionary<System.String, RefCount> refCounts = new System.Collections.Generic.Dictionary<System.String, RefCount>();
 		
-		/* Holds all commits (segments_N) currently in the index.
-		* This will have just 1 commit if you are using the
-		* default delete policy (KeepOnlyLastCommitDeletionPolicy).
-		* Other policies may leave commit points live for longer
-		* in which case this list would be longer than 1: */
+		//// Holds all commits (segments_N) currently in the index.
+		/// This will have just 1 commit if you are using the
+		/// default delete policy (KeepOnlyLastCommitDeletionPolicy).
+		/// Other policies may leave commit points live for longer
+		/// in which case this list would be longer than 1: ////
 		private System.Collections.ArrayList commits = new System.Collections.ArrayList();
 		
-		/* Holds files we had incref'd from the previous
-		* non-commit checkpoint: */
+		//// Holds files we had incref'd from the previous
+		/// non-commit checkpoint: ////
         private System.Collections.Generic.IList<string> lastFiles = new System.Collections.Generic.List<string>();
 		
-		/* Commits that the IndexDeletionPolicy have decided to delete: */
+		//// Commits that the IndexDeletionPolicy have decided to delete: ////
 		private System.Collections.ArrayList commitsToDelete = new System.Collections.ArrayList();
 		
 		private System.IO.StreamWriter infoStream;

Modified: incubator/lucene.net/trunk/src/core/Index/IndexFileNameFilter.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/IndexFileNameFilter.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/IndexFileNameFilter.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/IndexFileNameFilter.cs Sun Nov  6 05:24:26 2011
@@ -48,7 +48,7 @@ namespace Lucene.Net.Index
 		}
 		
 		/* (non-Javadoc)
-		* @see java.io.FilenameFilter#accept(java.io.File, java.lang.String)
+		* <see cref="java.io.FilenameFilter.accept(java.io.File, java.lang.String)"/>
 		*/
 		public virtual bool Accept(System.IO.FileInfo dir, System.String name)
 		{

Modified: incubator/lucene.net/trunk/src/core/Index/IndexFileNames.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/IndexFileNames.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/IndexFileNames.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/IndexFileNames.cs Sun Nov  6 05:24:26 2011
@@ -92,9 +92,9 @@ namespace Lucene.Net.Index
 		
 		/// <summary> This array contains all filename extensions used by
 		/// Lucene's index files, with two exceptions, namely the
-		/// extension made up from <code>.f</code> + a number and
-		/// from <code>.s</code> + a number.  Also note that
-		/// Lucene's <code>segments_N</code> files do not have any
+		/// extension made up from <c>.f</c> + a number and
+		/// from <c>.s</c> + a number.  Also note that
+		/// Lucene's <c>segments_N</c> files do not have any
 		/// filename extension.
 		/// </summary>
 		public /*internal*/ static readonly System.String[] INDEX_EXTENSIONS = new System.String[]{COMPOUND_FILE_EXTENSION, FIELD_INFOS_EXTENSION, FIELDS_INDEX_EXTENSION, FIELDS_EXTENSION, TERMS_INDEX_EXTENSION, TERMS_EXTENSION, FREQ_EXTENSION, PROX_EXTENSION, DELETES_EXTENSION, VECTORS_INDEX_EXTENSION, VECTORS_DOCUMENTS_EXTENSION, VECTORS_FIELDS_EXTENSION, GEN_EXTENSION, NORMS_EXTENSION, COMPOUND_FILE_STORE_EXTENSION};
@@ -120,7 +120,7 @@ namespace Lucene.Net.Index
 		/// If it's > 0, the file name is 
 		/// 
 		/// </summary>
-		/// <param name="base">-- main part of the file name
+        /// <param name="base_Renamed">-- main part of the file name
 		/// </param>
 		/// <param name="extension">-- extension of the filename (including .)
 		/// </param>

Modified: incubator/lucene.net/trunk/src/core/Index/IndexModifier.cs
URL: http://svn.apache.org/viewvc/incubator/lucene.net/trunk/src/core/Index/IndexModifier.cs?rev=1198132&r1=1198131&r2=1198132&view=diff
==============================================================================
--- incubator/lucene.net/trunk/src/core/Index/IndexModifier.cs (original)
+++ incubator/lucene.net/trunk/src/core/Index/IndexModifier.cs Sun Nov  6 05:24:26 2011
@@ -27,16 +27,16 @@ namespace Lucene.Net.Index
 {
 	
 	/// <summary> <p/>[Note that as of <b>2.1</b>, all but one of the
-	/// methods in this class are available via {@link
-	/// IndexWriter}.  The one method that is not available is
-	/// {@link #DeleteDocument(int)}.]<p/>
+	/// methods in this class are available via <see cref="IndexWriter" />
+	///.  The one method that is not available is
+	/// <see cref="DeleteDocument(int)" />.]<p/>
 	/// 
 	/// A class to modify an index, i.e. to delete and add documents. This
-	/// class hides {@link IndexReader} and {@link IndexWriter} so that you
+	/// class hides <see cref="IndexReader" /> and <see cref="IndexWriter" /> so that you
 	/// do not need to care about implementation details such as that adding
 	/// documents is done via IndexWriter and deletion is done via IndexReader.
 	/// 
-	/// <p/>Note that you cannot create more than one <code>IndexModifier</code> object
+	/// <p/>Note that you cannot create more than one <c>IndexModifier</c> object
 	/// on the same directory at the same time.
 	/// 
 	/// <p/>Example usage:
@@ -73,7 +73,7 @@ namespace Lucene.Net.Index
 	/// 
 	/// <p/>Not all methods of IndexReader and IndexWriter are offered by this
 	/// class. If you need access to additional methods, either use those classes
-	/// directly or implement your own class that extends <code>IndexModifier</code>.
+	/// directly or implement your own class that extends <c>IndexModifier</c>.
 	/// 
 	/// <p/>Although an instance of this class can be used from more than one
 	/// thread, you will not get the best performance. You might want to use
@@ -86,7 +86,7 @@ namespace Lucene.Net.Index
 	/// then add all the new documents.
 	/// 
 	/// </summary>
-	/// <deprecated> Please use {@link IndexWriter} instead.
+	/// <deprecated> Please use <see cref="IndexWriter" /> instead.
 	/// </deprecated>
     [Obsolete("Please use IndexWriter instead.")]
 	public class IndexModifier
@@ -119,12 +119,12 @@ namespace Lucene.Net.Index
 		/// </param>
 		/// <param name="analyzer">the analyzer to use for adding new documents
 		/// </param>
-		/// <param name="create"><code>true</code> to create the index or overwrite the existing one;
-		/// <code>false</code> to append to the existing index
+		/// <param name="create"><c>true</c> to create the index or overwrite the existing one;
+		/// <c>false</c> to append to the existing index
 		/// </param>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -141,12 +141,12 @@ namespace Lucene.Net.Index
 		/// </param>
 		/// <param name="analyzer">the analyzer to use for adding new documents
 		/// </param>
-		/// <param name="create"><code>true</code> to create the index or overwrite the existing one;
-		/// <code>false</code> to append to the existing index
+		/// <param name="create"><c>true</c> to create the index or overwrite the existing one;
+		/// <c>false</c> to append to the existing index
 		/// </param>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -165,12 +165,12 @@ namespace Lucene.Net.Index
 		/// </param>
 		/// <param name="analyzer">the analyzer to use for adding new documents
 		/// </param>
-		/// <param name="create"><code>true</code> to create the index or overwrite the existing one;
-		/// <code>false</code> to append to the existing index
+		/// <param name="create"><c>true</c> to create the index or overwrite the existing one;
+		/// <c>false</c> to append to the existing index
 		/// </param>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -185,7 +185,7 @@ namespace Lucene.Net.Index
 		/// <summary> Initialize an IndexWriter.</summary>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -213,7 +213,7 @@ namespace Lucene.Net.Index
 		/// <summary> Close the IndexReader and open an IndexWriter.</summary>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -258,7 +258,7 @@ namespace Lucene.Net.Index
 		/// <summary> Make sure all changes are written to disk.</summary>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -284,7 +284,7 @@ namespace Lucene.Net.Index
 		
 		/// <summary> Adds a document to this index, using the provided analyzer instead of the
 		/// one specific in the constructor.  If the document contains more than
-		/// {@link #SetMaxFieldLength(int)} terms for a given field, the remainder are
+		/// <see cref="SetMaxFieldLength(int)" /> terms for a given field, the remainder are
 		/// discarded.
 		/// </summary>
 		/// <seealso cref="IndexWriter.AddDocument(Document, Analyzer)">
@@ -292,7 +292,7 @@ namespace Lucene.Net.Index
 		/// <throws>  IllegalStateException if the index is closed </throws>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -310,7 +310,7 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary> Adds a document to this index.  If the document contains more than
-		/// {@link #SetMaxFieldLength(int)} terms for a given field, the remainder are
+		/// <see cref="SetMaxFieldLength(int)" /> terms for a given field, the remainder are
 		/// discarded.
 		/// </summary>
 		/// <seealso cref="IndexWriter.AddDocument(Document)">
@@ -318,7 +318,7 @@ namespace Lucene.Net.Index
 		/// <throws>  IllegalStateException if the index is closed </throws>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -327,7 +327,7 @@ namespace Lucene.Net.Index
 			AddDocument(doc, null);
 		}
 		
-		/// <summary> Deletes all documents containing <code>term</code>.
+		/// <summary> Deletes all documents containing <c>term</c>.
 		/// This is useful if one uses a document field to hold a unique ID string for
 		/// the document.  Then to delete such a document, one merely constructs a
 		/// term with the appropriate field and the unique ID string as its text and
@@ -343,7 +343,7 @@ namespace Lucene.Net.Index
 		/// </summary>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -357,7 +357,7 @@ namespace Lucene.Net.Index
 			}
 		}
 		
-		/// <summary> Deletes the document numbered <code>docNum</code>.</summary>
+		/// <summary> Deletes the document numbered <c>docNum</c>.</summary>
 		/// <seealso cref="IndexReader.DeleteDocument(int)">
 		/// </seealso>
 		/// <throws>  StaleReaderException if the index has changed </throws>
@@ -365,7 +365,7 @@ namespace Lucene.Net.Index
 		/// </summary>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IllegalStateException if the index is closed </throws>
@@ -382,10 +382,10 @@ namespace Lucene.Net.Index
 		
 		/// <summary> Returns the number of documents currently in this
 		/// index.  If the writer is currently open, this returns
-		/// {@link IndexWriter#DocCount()}, else {@link
-		/// IndexReader#NumDocs()}.  But, note that {@link
-		/// IndexWriter#DocCount()} does not take deletions into
-		/// account, unlike {@link IndexReader#numDocs}.
+		/// <see cref="IndexWriter.DocCount()" />, else <see cref="IndexReader.NumDocs()" />
+		///.  But, note that <see cref="IndexWriter.DocCount()" />
+		/// does not take deletions into
+		/// account, unlike <see cref="IndexReader.NumDocs" />.
 		/// </summary>
 		/// <throws>  IllegalStateException if the index is closed </throws>
 		public virtual int DocCount()
@@ -412,7 +412,7 @@ namespace Lucene.Net.Index
 		/// <throws>  IllegalStateException if the index is closed </throws>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -427,10 +427,10 @@ namespace Lucene.Net.Index
 		}
 		
 		/// <summary> If non-null, information about merges and a message when
-		/// {@link #GetMaxFieldLength()} is reached will be printed to this.
+		/// <see cref="GetMaxFieldLength()" /> is reached will be printed to this.
 		/// <p/>Example: <tt>index.setInfoStream(System.err);</tt>
 		/// </summary>
-		/// <seealso cref="IndexWriter.SetInfoStream(PrintStream)">
+		/// <seealso cref="IndexWriter.SetInfoStream(System.IO.StreamWriter)">
 		/// </seealso>
 		/// <throws>  IllegalStateException if the index is closed </throws>
 		public virtual void  SetInfoStream(System.IO.StreamWriter infoStream)
@@ -446,11 +446,11 @@ namespace Lucene.Net.Index
 			}
 		}
 		
-		/// <seealso cref="IndexModifier.SetInfoStream(PrintStream)">
+		/// <seealso cref="IndexModifier.SetInfoStream(System.IO.StreamWriter)">
 		/// </seealso>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -468,7 +468,7 @@ namespace Lucene.Net.Index
 		/// for each segment are merged into a single file once the segment creation
 		/// is finished. This is done regardless of what directory is in use.
 		/// </summary>
-		/// <seealso cref="IndexWriter.SetUseCompoundFile(boolean)">
+        /// <seealso cref="IndexWriter.SetUseCompoundFile(bool)">
 		/// </seealso>
 		/// <throws>  IllegalStateException if the index is closed </throws>
 		public virtual void  SetUseCompoundFile(bool useCompoundFile)
@@ -483,12 +483,12 @@ namespace Lucene.Net.Index
 				this.useCompoundFile = useCompoundFile;
 			}
 		}
-		
-		/// <seealso cref="IndexModifier.SetUseCompoundFile(boolean)">
+
+        /// <seealso cref="IndexModifier.SetUseCompoundFile(bool)">
 		/// </seealso>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -533,7 +533,7 @@ namespace Lucene.Net.Index
 		/// </seealso>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -549,7 +549,7 @@ namespace Lucene.Net.Index
 		
 		/// <summary> Determines the minimal number of documents required before the buffered
 		/// in-memory documents are merging and a new Segment is created.
-		/// Since Documents are merged in a {@link Lucene.Net.Store.RAMDirectory},
+		/// Since Documents are merged in a <see cref="Lucene.Net.Store.RAMDirectory" />,
 		/// large value gives faster indexing.  At the same time, mergeFactor limits
 		/// the number of files open in a FSDirectory.
 		/// 
@@ -577,7 +577,7 @@ namespace Lucene.Net.Index
 		/// </seealso>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>
@@ -621,7 +621,7 @@ namespace Lucene.Net.Index
 		/// </seealso>
 		/// <throws>  CorruptIndexException if the index is corrupt </throws>
 		/// <throws>  LockObtainFailedException if another writer </throws>
-		/// <summary>  has this index open (<code>write.lock</code> could not
+		/// <summary>  has this index open (<c>write.lock</c> could not
 		/// be obtained)
 		/// </summary>
 		/// <throws>  IOException if there is a low-level IO error </throws>



Mime
View raw message