lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject [41/48] lucenenet git commit: Lucene.Net.Codecs.Lucene40: Fixed XML documentation comment warnings
Date Tue, 06 Jun 2017 00:12:14 GMT
Lucene.Net.Codecs.Lucene40: Fixed XML documentation comment warnings


Project: http://git-wip-us.apache.org/repos/asf/lucenenet/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucenenet/commit/27cdd048
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/27cdd048
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/27cdd048

Branch: refs/heads/master
Commit: 27cdd0480ae5d8f4c83ae73557e77fa8d589792c
Parents: 3221b63
Author: Shad Storhaug <shad@shadstorhaug.com>
Authored: Mon Jun 5 14:10:17 2017 +0700
Committer: Shad Storhaug <shad@shadstorhaug.com>
Committed: Tue Jun 6 06:58:41 2017 +0700

----------------------------------------------------------------------
 CONTRIBUTING.md                                 |   3 +-
 src/Lucene.Net/Codecs/Lucene40/BitVector.cs     |  67 +++---
 src/Lucene.Net/Codecs/Lucene40/Lucene40Codec.cs |  14 +-
 .../Codecs/Lucene40/Lucene40DocValuesFormat.cs  | 158 ++++++-------
 .../Codecs/Lucene40/Lucene40DocValuesReader.cs  |  17 +-
 .../Codecs/Lucene40/Lucene40FieldInfosFormat.cs | 126 +++++-----
 .../Codecs/Lucene40/Lucene40FieldInfosReader.cs |   8 +-
 .../Codecs/Lucene40/Lucene40LiveDocsFormat.cs   |  52 ++---
 .../Codecs/Lucene40/Lucene40NormsFormat.cs      |  18 +-
 .../Lucene40/Lucene40PostingsBaseFormat.cs      |   6 +-
 .../Codecs/Lucene40/Lucene40PostingsFormat.cs   | 232 +++++++++----------
 .../Codecs/Lucene40/Lucene40PostingsReader.cs   |  11 +-
 .../Lucene40/Lucene40SegmentInfoFormat.cs       |  75 +++---
 .../Lucene40/Lucene40SegmentInfoReader.cs       |   8 +-
 .../Lucene40/Lucene40SegmentInfoWriter.cs       |   7 +-
 .../Codecs/Lucene40/Lucene40SkipListReader.cs   |  11 +-
 .../Lucene40/Lucene40StoredFieldsFormat.cs      |  96 ++++----
 .../Lucene40/Lucene40StoredFieldsReader.cs      |  30 +--
 .../Lucene40/Lucene40StoredFieldsWriter.cs      |  21 +-
 .../Lucene40/Lucene40TermVectorsFormat.cs       | 139 ++++++-----
 .../Lucene40/Lucene40TermVectorsReader.cs       |  23 +-
 .../Lucene40/Lucene40TermVectorsWriter.cs       |   8 +-
 22 files changed, 559 insertions(+), 571 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 5f422f8..c8a36fb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -53,8 +53,7 @@ helpers to help with that, see for examples see our [Java style methods to avoid
 1. Lucene.Net.Core (project)
    1. Codecs.Compressing (namespace)
    2. Codecs.Lucene3x (namespace)
-   3. Codecs.Lucene40 (namespace)
-   4. Util.Packed (namespace)
+   3. Util.Packed (namespace)
 2. Lucene.Net.Codecs (project)
    1. Appending (namespace)
    2. BlockTerms (namespace)

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/BitVector.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/BitVector.cs b/src/Lucene.Net/Codecs/Lucene40/BitVector.cs
index 57a7e14..eb1605a 100644
--- a/src/Lucene.Net/Codecs/Lucene40/BitVector.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/BitVector.cs
@@ -32,16 +32,16 @@ namespace Lucene.Net.Codecs.Lucene40
     using IMutableBits = Lucene.Net.Util.IMutableBits;
 
     /// <summary>
-    /// Optimized implementation of a vector of bits.  this is more-or-less like
-    ///  java.util.BitSet, but also includes the following:
-    ///  <ul>
-    ///  <li>a count() method, which efficiently computes the number of one bits;</li>
-    ///  <li>optimized read from and write to disk;</li>
-    ///  <li>inlinable get() method;</li>
-    ///  <li>store and load, as bit set or d-gaps, depending on sparseness;</li>
-    ///  </ul>
-    ///
-    ///  @lucene.internal
+    /// Optimized implementation of a vector of bits.  This is more-or-less like
+    /// <c>java.util.BitSet</c>, but also includes the following:
+    /// <list type="bullet">
+    ///     <item><description>a count() method, which efficiently computes the number of one bits;</description></item>
+    ///     <item><description>optimized read from and write to disk;</description></item>
+    ///     <item><description>inlinable get() method;</description></item>
+    ///     <item><description>store and load, as bit set or d-gaps, depending on sparseness;</description></item>
+    /// </list>
+    /// <para/>
+    /// @lucene.internal
     /// </summary>
     // pkg-private: if this thing is generally useful then it can go back in .util,
     // but the serialization must be here underneath the codec.
@@ -53,7 +53,7 @@ namespace Lucene.Net.Codecs.Lucene40
         private int version;
 
         /// <summary>
-        /// Constructs a vector capable of holding <code>n</code> bits. </summary>
+        /// Constructs a vector capable of holding <paramref name="n"/> bits. </summary>
         public BitVector(int n)
         {
             size = n;
@@ -88,7 +88,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Sets the value of <code>bit</code> to one. </summary>
+        /// Sets the value of <paramref name="bit"/> to one. </summary>
         public void Set(int bit)
         {
             if (bit >= size)
@@ -100,8 +100,8 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Sets the value of <code>bit</code> to true, and
-        ///  returns true if bit was already set
+        /// Sets the value of <paramref name="bit"/> to <c>true</c>, and
+        /// returns <c>true</c> if bit was already set.
         /// </summary>
         public bool GetAndSet(int bit)
         {
@@ -129,7 +129,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Sets the value of <code>bit</code> to zero. </summary>
+        /// Sets the value of <paramref name="bit"/> to zero. </summary>
         public void Clear(int bit)
         {
             if (bit >= size)
@@ -166,8 +166,8 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Returns <code>true</code> if <code>bit</code> is one and
-        ///  <code>false</code> if it is zero.
+        /// Returns <c>true</c> if <paramref name="bit"/> is one and
+        /// <c>false</c> if it is zero.
         /// </summary>
         public bool Get(int bit)
         {
@@ -186,8 +186,9 @@ namespace Lucene.Net.Codecs.Lucene40
         //}
 
         /// <summary>
-        /// Returns the number of bits in this vector.  this is also one greater than
+        /// Returns the number of bits in this vector.  This is also one greater than
         /// the number of the largest valid bit number.
+        /// <para/>
         /// This is the equivalent of either size() or length() in Lucene.
         /// </summary>
         public int Length
@@ -196,9 +197,9 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Returns the total number of one bits in this vector.  this is efficiently
-        ///  computed and cached, so that, if the vector is not changed, no
-        ///  recomputation is done for repeated calls.
+        /// Returns the total number of one bits in this vector.  This is efficiently
+        /// computed and cached, so that, if the vector is not changed, no
+        /// recomputation is done for repeated calls.
         /// </summary>
         public int Count()
         {
@@ -257,9 +258,9 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Writes this vector to the file <code>name</code> in Directory
-        ///  <code>d</code>, in a format that can be read by the constructor {@link
-        ///  #BitVector(Directory, String, IOContext)}.
+        /// Writes this vector to the file <paramref name="name"/> in Directory
+        /// <paramref name="d"/>, in a format that can be read by the constructor 
+        /// <see cref="BitVector(Directory, string, IOContext)"/>.
         /// </summary>
         public void Write(Directory d, string name, IOContext context)
         {
@@ -289,7 +290,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Invert all bits </summary>
+        /// Invert all bits. </summary>
         public void InvertAll()
         {
             if (count != -1)
@@ -322,7 +323,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Set all bits </summary>
+        /// Set all bits. </summary>
         public void SetAll()
         {
             Arrays.Fill(bits, (byte)0xff);
@@ -331,7 +332,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Write as a bit set </summary>
+        /// Write as a bit set. </summary>
         private void WriteBits(IndexOutput output)
         {
             output.WriteInt32(Length); // write size
@@ -340,7 +341,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Write as a d-gaps list </summary>
+        /// Write as a d-gaps list. </summary>
         private void WriteClearedDgaps(IndexOutput output)
         {
             output.WriteInt32(-1); // mark using d-gaps
@@ -412,8 +413,8 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Constructs a bit vector from the file <code>name</code> in Directory
-        ///  <code>d</code>, as written by the <seealso cref="#write"/> method.
+        /// Constructs a bit vector from the file <paramref name="name"/> in Directory
+        /// <paramref name="d"/>, as written by the <see cref="Write(Directory, string, IOContext)"/> method.
         /// </summary>
         public BitVector(Directory d, string name, IOContext context)
         {
@@ -486,7 +487,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Read as a bit set </summary>
+        /// Read as a bit set. </summary>
         private void ReadBits(IndexInput input)
         {
             count = input.ReadInt32(); // read count
@@ -495,7 +496,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// read as a d-gaps list </summary>
+        /// Read as a d-gaps list. </summary>
         private void ReadSetDgaps(IndexInput input)
         {
             size = input.ReadInt32(); // (re)read size
@@ -513,7 +514,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// read as a d-gaps cleared bits list </summary>
+        /// Read as a d-gaps cleared bits list. </summary>
         private void ReadClearedDgaps(IndexInput input)
         {
             size = input.ReadInt32(); // (re)read size

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40Codec.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40Codec.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40Codec.cs
index d0cc900..fd5ce7b 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40Codec.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40Codec.cs
@@ -23,12 +23,12 @@ namespace Lucene.Net.Codecs.Lucene40
 
     /// <summary>
     /// Implements the Lucene 4.0 index format, with configurable per-field postings formats.
-    /// <p>
+    /// <para/>
     /// If you want to reuse functionality of this codec in another codec, extend
-    /// <seealso cref="FilterCodec"/>.
+    /// <see cref="FilterCodec"/>.
+    /// <para/>
+    /// See <see cref="Lucene.Net.Codecs.Lucene40"/> package documentation for file format details.
     /// </summary>
-    /// <seealso cref= Lucene.Net.Codecs.Lucene40 package documentation for file format details. </seealso>
-    /// @deprecated Only for reading old 4.0 segments
     // NOTE: if we make largish changes in a minor release, easier to just make Lucene42Codec or whatever
     // if they are backwards compatible or smallish we can probably do the backwards in the postingsreader
     // (it writes a minor version, etc).
@@ -113,9 +113,9 @@ namespace Lucene.Net.Codecs.Lucene40
 
         /// <summary>
         /// Returns the postings format that should be used for writing
-        ///  new segments of <code>field</code>.
-        ///
-        ///  The default implementation always returns "Lucene40"
+        /// new segments of <paramref name="field"/>.
+        /// <para/>
+        /// The default implementation always returns "Lucene40".
         /// </summary>
         public virtual PostingsFormat GetPostingsFormatForField(string field)
         {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesFormat.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesFormat.cs
index 5c658b4..93227e5 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesFormat.cs
@@ -25,98 +25,98 @@ namespace Lucene.Net.Codecs.Lucene40
 
     /// <summary>
     /// Lucene 4.0 DocValues format.
-    /// <p>
+    /// <para/>
     /// Files:
-    /// <ul>
-    ///   <li><tt>.dv.cfs</tt>: <seealso cref="CompoundFileDirectory compound container"/></li>
-    ///   <li><tt>.dv.cfe</tt>: <seealso cref="CompoundFileDirectory compound entries"/></li>
-    /// </ul>
+    /// <list type="bullet">
+    ///   <item><description><c>.dv.cfs</c>: compound container (<see cref="Store.CompoundFileDirectory"/>)</description></item>
+    ///   <item><description><c>.dv.cfe</c>: compound entries (<see cref="Store.CompoundFileDirectory"/>)</description></item>
+    /// </list>
     /// Entries within the compound file:
-    /// <ul>
-    ///   <li><tt>&lt;segment&gt;_&lt;fieldNumber&gt;.dat</tt>: data values</li>
-    ///   <li><tt>&lt;segment&gt;_&lt;fieldNumber&gt;.idx</tt>: index into the .dat for DEREF types</li>
-    /// </ul>
-    /// <p>
-    /// There are several many types of {@code DocValues} with different encodings.
-    /// From the perspective of filenames, all types store their values in <tt>.dat</tt>
-    /// entries within the compound file. In the case of dereferenced/sorted types, the <tt>.dat</tt>
-    /// actually contains only the unique values, and an additional <tt>.idx</tt> file contains
+    /// <list type="bullet">
+    ///   <item><description><c>&lt;segment&gt;_&lt;fieldNumber&gt;.dat</c>: data values</description></item>
+    ///   <item><description><c>&lt;segment&gt;_&lt;fieldNumber&gt;.idx</c>: index into the .dat for DEREF types</description></item>
+    /// </list>
+    /// <para>
+    /// There are several many types of <see cref="Index.DocValues"/> with different encodings.
+    /// From the perspective of filenames, all types store their values in <c>.dat</c>
+    /// entries within the compound file. In the case of dereferenced/sorted types, the <c>.dat</c>
+    /// actually contains only the unique values, and an additional <c>.idx</c> file contains
     /// pointers to these unique values.
-    /// </p>
+    /// </para>
     /// Formats:
-    /// <ul>
-    ///    <li>{@code VAR_INTS} .dat --&gt; Header, PackedType, MinValue,
-    ///        DefaultValue, PackedStream</li>
-    ///    <li>{@code FIXED_INTS_8} .dat --&gt; Header, ValueSize,
-    ///        <seealso cref="DataOutput#writeByte Byte"/><sup>maxdoc</sup></li>
-    ///    <li>{@code FIXED_INTS_16} .dat --&gt; Header, ValueSize,
-    ///        <seealso cref="DataOutput#writeShort Short"/><sup>maxdoc</sup></li>
-    ///    <li>{@code FIXED_INTS_32} .dat --&gt; Header, ValueSize,
-    ///        <seealso cref="DataOutput#writeInt Int32"/><sup>maxdoc</sup></li>
-    ///    <li>{@code FIXED_INTS_64} .dat --&gt; Header, ValueSize,
-    ///        <seealso cref="DataOutput#writeLong Int64"/><sup>maxdoc</sup></li>
-    ///    <li>{@code FLOAT_32} .dat --&gt; Header, ValueSize, Float32<sup>maxdoc</sup></li>
-    ///    <li>{@code FLOAT_64} .dat --&gt; Header, ValueSize, Float64<sup>maxdoc</sup></li>
-    ///    <li>{@code BYTES_FIXED_STRAIGHT} .dat --&gt; Header, ValueSize,
-    ///        (<seealso cref="DataOutput#writeByte Byte"/> * ValueSize)<sup>maxdoc</sup></li>
-    ///    <li>{@code BYTES_VAR_STRAIGHT} .idx --&gt; Header, TotalBytes, Addresses</li>
-    ///    <li>{@code BYTES_VAR_STRAIGHT} .dat --&gt; Header,
-    ///          (<seealso cref="DataOutput#writeByte Byte"/> * <i>variable ValueSize</i>)<sup>maxdoc</sup></li>
-    ///    <li>{@code BYTES_FIXED_DEREF} .idx --&gt; Header, NumValues, Addresses</li>
-    ///    <li>{@code BYTES_FIXED_DEREF} .dat --&gt; Header, ValueSize,
-    ///        (<seealso cref="DataOutput#writeByte Byte"/> * ValueSize)<sup>NumValues</sup></li>
-    ///    <li>{@code BYTES_VAR_DEREF} .idx --&gt; Header, TotalVarBytes, Addresses</li>
-    ///    <li>{@code BYTES_VAR_DEREF} .dat --&gt; Header,
-    ///        (LengthPrefix + <seealso cref="DataOutput#writeByte Byte"/> * <i>variable ValueSize</i>)<sup>NumValues</sup></li>
-    ///    <li>{@code BYTES_FIXED_SORTED} .idx --&gt; Header, NumValues, Ordinals</li>
-    ///    <li>{@code BYTES_FIXED_SORTED} .dat --&gt; Header, ValueSize,
-    ///        (<seealso cref="DataOutput#writeByte Byte"/> * ValueSize)<sup>NumValues</sup></li>
-    ///    <li>{@code BYTES_VAR_SORTED} .idx --&gt; Header, TotalVarBytes, Addresses, Ordinals</li>
-    ///    <li>{@code BYTES_VAR_SORTED} .dat --&gt; Header,
-    ///        (<seealso cref="DataOutput#writeByte Byte"/> * <i>variable ValueSize</i>)<sup>NumValues</sup></li>
-    /// </ul>
+    /// <list type="bullet">
+    ///    <item><description><see cref="LegacyDocValuesType.VAR_INTS"/> .dat --&gt; Header, PackedType, MinValue,
+    ///        DefaultValue, PackedStream</description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.FIXED_INTS_8"/> .dat --&gt; Header, ValueSize,
+    ///        Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) <sup>maxdoc</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.FIXED_INTS_16"/> .dat --&gt; Header, ValueSize,
+    ///        Short (<see cref="Store.DataOutput.WriteInt16(short)"/>) <sup>maxdoc</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.FIXED_INTS_32"/> .dat --&gt; Header, ValueSize,
+    ///        Int32 (<see cref="Store.DataOutput.WriteInt32(int)"/>) <sup>maxdoc</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.FIXED_INTS_64"/> .dat --&gt; Header, ValueSize,
+    ///        Int64 (<see cref="Store.DataOutput.WriteInt64(long)"/>) <sup>maxdoc</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.FLOAT_32"/> .dat --&gt; Header, ValueSize, Float32<sup>maxdoc</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.FLOAT_64"/> .dat --&gt; Header, ValueSize, Float64<sup>maxdoc</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_FIXED_STRAIGHT"/> .dat --&gt; Header, ValueSize,
+    ///        (Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) * ValueSize)<sup>maxdoc</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_VAR_STRAIGHT"/> .idx --&gt; Header, TotalBytes, Addresses</description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_VAR_STRAIGHT"/> .dat --&gt; Header,
+    ///          (Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) * <i>variable ValueSize</i>)<sup>maxdoc</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_FIXED_DEREF"/> .idx --&gt; Header, NumValues, Addresses</description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_FIXED_DEREF"/> .dat --&gt; Header, ValueSize,
+    ///        (Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) * ValueSize)<sup>NumValues</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_VAR_DEREF"/> .idx --&gt; Header, TotalVarBytes, Addresses</description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_VAR_DEREF"/> .dat --&gt; Header,
+    ///        (LengthPrefix + Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) * <i>variable ValueSize</i>)<sup>NumValues</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_FIXED_SORTED"/> .idx --&gt; Header, NumValues, Ordinals</description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_FIXED_SORTED"/> .dat --&gt; Header, ValueSize,
+    ///        (Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) * ValueSize)<sup>NumValues</sup></description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_VAR_SORTED"/> .idx --&gt; Header, TotalVarBytes, Addresses, Ordinals</description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_VAR_SORTED"/> .dat --&gt; Header,
+    ///        (Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) * <i>variable ValueSize</i>)<sup>NumValues</sup></description></item>
+    /// </list>
     /// Data Types:
-    /// <ul>
-    ///    <li>Header --&gt; <seealso cref="CodecUtil#writeHeader CodecHeader"/></li>
-    ///    <li>PackedType --&gt; <seealso cref="DataOutput#writeByte Byte"/></li>
-    ///    <li>MaxAddress, MinValue, DefaultValue --&gt; <seealso cref="DataOutput#writeLong Int64"/></li>
-    ///    <li>PackedStream, Addresses, Ordinals --&gt; <seealso cref="PackedInts"/></li>
-    ///    <li>ValueSize, NumValues --&gt; <seealso cref="DataOutput#writeInt Int32"/></li>
-    ///    <li>Float32 --&gt; 32-bit float encoded with <seealso cref="Float#floatToRawIntBits(float)"/>
-    ///                       then written as <seealso cref="DataOutput#writeInt Int32"/></li>
-    ///    <li>Float64 --&gt; 64-bit float encoded with <seealso cref="Double#doubleToRawLongBits(double)"/>
-    ///                       then written as <seealso cref="DataOutput#writeLong Int64"/></li>
-    ///    <li>TotalBytes --&gt; <seealso cref="DataOutput#writeVLong VLong"/></li>
-    ///    <li>TotalVarBytes --&gt; <seealso cref="DataOutput#writeLong Int64"/></li>
-    ///    <li>LengthPrefix --&gt; Length of the data value as <seealso cref="DataOutput#writeVInt VInt"/> (maximum
-    ///                       of 2 bytes)</li>
-    /// </ul>
+    /// <list type="bullet">
+    ///    <item><description>Header --&gt; CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item>
+    ///    <item><description>PackedType --&gt; Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>)</description></item>
+    ///    <item><description>MaxAddress, MinValue, DefaultValue --&gt; Int64 (<see cref="Store.DataOutput.WriteInt64(long)"/>) </description></item>
+    ///    <item><description>PackedStream, Addresses, Ordinals --&gt; <see cref="Util.Packed.PackedInt32s"/></description></item>
+    ///    <item><description>ValueSize, NumValues --&gt; Int32 (<see cref="Store.DataOutput.WriteInt32(int)"/>) </description></item>
+    ///    <item><description>Float32 --&gt; 32-bit float encoded with <see cref="Support.Number.SingleToRawInt32Bits(float)"/>
+    ///                       then written as Int32 (<see cref="Store.DataOutput.WriteInt32(int)"/>) </description></item>
+    ///    <item><description>Float64 --&gt; 64-bit float encoded with <see cref="Support.Number.DoubleToRawInt64Bits(double)"/>
+    ///                       then written as Int64 (<see cref="Store.DataOutput.WriteInt64(long)"/>) </description></item>
+    ///    <item><description>TotalBytes --&gt; VLong (<see cref="Store.DataOutput.WriteVInt64(long)"/>) </description></item>
+    ///    <item><description>TotalVarBytes --&gt; Int64 (<see cref="Store.DataOutput.WriteInt64(long)"/>) </description></item>
+    ///    <item><description>LengthPrefix --&gt; Length of the data value as VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) (maximum
+    ///                       of 2 bytes)</description></item>
+    /// </list>
     /// Notes:
-    /// <ul>
-    ///    <li>PackedType is a 0 when compressed, 1 when the stream is written as 64-bit integers.</li>
-    ///    <li>Addresses stores pointers to the actual byte location (indexed by docid). In the VAR_STRAIGHT
+    /// <list type="bullet">
+    ///    <item><description>PackedType is a 0 when compressed, 1 when the stream is written as 64-bit integers.</description></item>
+    ///    <item><description>Addresses stores pointers to the actual byte location (indexed by docid). In the VAR_STRAIGHT
     ///        case, each entry can have a different length, so to determine the length, docid+1 is
     ///        retrieved. A sentinel address is written at the end for the VAR_STRAIGHT case, so the Addresses
     ///        stream contains maxdoc+1 indices. For the deduplicated VAR_DEREF case, each length
-    ///        is encoded as a prefix to the data itself as a <seealso cref="DataOutput#writeVInt VInt"/>
-    ///        (maximum of 2 bytes).</li>
-    ///    <li>Ordinals stores the term ID in sorted order (indexed by docid). In the FIXED_SORTED case,
+    ///        is encoded as a prefix to the data itself as a VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>)
+    ///        (maximum of 2 bytes).</description></item>
+    ///    <item><description>Ordinals stores the term ID in sorted order (indexed by docid). In the FIXED_SORTED case,
     ///        the address into the .dat can be computed from the ordinal as
-    ///        <code>Header+ValueSize+(ordinal*ValueSize)</code> because the byte length is fixed.
+    ///        <c>Header+ValueSize+(ordinal*ValueSize)</c> because the byte length is fixed.
     ///        In the VAR_SORTED case, there is double indirection (docid -> ordinal -> address), but
     ///        an additional sentinel ordinal+address is always written (so there are NumValues+1 ordinals). To
-    ///        determine the length, ord+1's address is looked up as well.</li>
-    ///    <li>{@code BYTES_VAR_STRAIGHT BYTES_VAR_STRAIGHT} in contrast to other straight
-    ///        variants uses a <tt>.idx</tt> file to improve lookup perfromance. In contrast to
-    ///        {@code BYTES_VAR_DEREF BYTES_VAR_DEREF} it doesn't apply deduplication of the document values.
-    ///    </li>
-    /// </ul>
-    /// <p>
+    ///        determine the length, ord+1's address is looked up as well.</description></item>
+    ///    <item><description><see cref="LegacyDocValuesType.BYTES_VAR_STRAIGHT"/> in contrast to other straight
+    ///        variants uses a <c>.idx</c> file to improve lookup perfromance. In contrast to
+    ///        <see cref="LegacyDocValuesType.BYTES_VAR_DEREF"/> it doesn't apply deduplication of the document values.
+    ///    </description></item>
+    /// </list>
+    /// <para/>
     /// Limitations:
-    /// <ul>
-    ///   <li> Binary doc values can be at most <seealso cref="#MAX_BINARY_FIELD_LENGTH"/> in length.
-    /// </ul> </summary>
-    /// @deprecated Only for reading old 4.0 and 4.1 segments
+    /// <list type="bullet">
+    ///   <item><description> Binary doc values can be at most <see cref="MAX_BINARY_FIELD_LENGTH"/> in length.</description></item>
+    /// </list> 
+    /// </summary>
     [Obsolete("Only for reading old 4.0 and 4.1 segments")]
     [DocValuesFormatName("Lucene40")] // LUCENENET specific - using DocValuesFormatName attribute to ensure the default name passed from subclasses is the same as this class name
     public class Lucene40DocValuesFormat : DocValuesFormat

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesReader.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesReader.cs
index 54d3511..bca9a0c 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40DocValuesReader.cs
@@ -42,9 +42,10 @@ namespace Lucene.Net.Codecs.Lucene40
     using SortedSetDocValues = Lucene.Net.Index.SortedSetDocValues;
 
     /// <summary>
-    /// Reads the 4.0 format of norms/docvalues
-    /// @lucene.experimental </summary>
-    /// @deprecated Only for reading old 4.0 and 4.1 segments
+    /// Reads the 4.0 format of norms/docvalues.
+    /// <para/>
+    /// @lucene.experimental 
+    /// </summary>
     [Obsolete("Only for reading old 4.0 and 4.1 segments")]
     internal sealed class Lucene40DocValuesReader : DocValuesProducer
     {
@@ -139,7 +140,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// NOTE: This was loadVarIntsField() in Lucene
+        /// NOTE: This was loadVarIntsField() in Lucene.
         /// </summary>
         private NumericDocValues LoadVarInt32sField(FieldInfo field, IndexInput input)
         {
@@ -243,7 +244,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// NOTE: This was loadShortField() in Lucene
+        /// NOTE: This was loadShortField() in Lucene.
         /// </summary>
         private NumericDocValues LoadInt16Field(FieldInfo field, IndexInput input)
         {
@@ -279,7 +280,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// NOTE: This was loadIntField() in Lucene
+        /// NOTE: This was loadIntField() in Lucene.
         /// </summary>
         private NumericDocValues LoadInt32Field(FieldInfo field, IndexInput input)
         {
@@ -315,7 +316,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// NOTE: This was loadLongField() in Lucene
+        /// NOTE: This was loadLongField() in Lucene.
         /// </summary>
         private NumericDocValues LoadInt64Field(FieldInfo field, IndexInput input)
         {
@@ -351,7 +352,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// NOTE: This was loadFloatField() in Lucene
+        /// NOTE: This was loadFloatField() in Lucene.
         /// </summary>
         private NumericDocValues LoadSingleField(FieldInfo field, IndexInput input)
         {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosFormat.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosFormat.cs
index a38dc52..49b5008 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosFormat.cs
@@ -19,76 +19,74 @@ namespace Lucene.Net.Codecs.Lucene40
      * limitations under the License.
      */
 
-    // javadoc
-
     /// <summary>
     /// Lucene 4.0 Field Infos format.
-    /// <p>
-    /// <p>Field names are stored in the field info file, with suffix <tt>.fnm</tt>.</p>
-    /// <p>FieldInfos (.fnm) --&gt; Header,FieldsCount, &lt;FieldName,FieldNumber,
-    /// FieldBits,DocValuesBits,Attributes&gt; <sup>FieldsCount</sup></p>
-    /// <p>Data types:
-    /// <ul>
-    ///   <li>Header --&gt; <seealso cref="CodecUtil#checkHeader CodecHeader"/></li>
-    ///   <li>FieldsCount --&gt; <seealso cref="DataOutput#writeVInt VInt"/></li>
-    ///   <li>FieldName --&gt; <seealso cref="DataOutput#writeString String"/></li>
-    ///   <li>FieldBits, DocValuesBits --&gt; <seealso cref="DataOutput#writeByte Byte"/></li>
-    ///   <li>FieldNumber --&gt; <seealso cref="DataOutput#writeInt VInt"/></li>
-    ///   <li>Attributes --&gt; <seealso cref="DataOutput#writeStringStringMap Map&lt;String,String&gt;"/></li>
-    /// </ul>
-    /// </p>
+    /// <para/>
+    /// <para>Field names are stored in the field info file, with suffix <tt>.fnm</tt>.</para>
+    /// <para>FieldInfos (.fnm) --&gt; Header,FieldsCount, &lt;FieldName,FieldNumber,
+    /// FieldBits,DocValuesBits,Attributes&gt; <sup>FieldsCount</sup></para>
+    /// <para>Data types:
+    /// <list type="bullet">
+    ///   <item><description>Header --&gt; CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item>
+    ///   <item><description>FieldsCount --&gt; VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item>
+    ///   <item><description>FieldName --&gt; String (<see cref="Store.DataOutput.WriteString(string)"/>) </description></item>
+    ///   <item><description>FieldBits, DocValuesBits --&gt; Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) </description></item>
+    ///   <item><description>FieldNumber --&gt; VInt (<see cref="Store.DataOutput.WriteInt32(int)"/>) </description></item>
+    ///   <item><description>Attributes --&gt; IDictionary&lt;String,String&gt; (<see cref="Store.DataOutput.WriteStringStringMap(System.Collections.Generic.IDictionary{string, string})"/>) </description></item>
+    /// </list>
+    /// </para>
     /// Field Descriptions:
-    /// <ul>
-    ///   <li>FieldsCount: the number of fields in this file.</li>
-    ///   <li>FieldName: name of the field as a UTF-8 String.</li>
-    ///   <li>FieldNumber: the field's number. Note that unlike previous versions of
+    /// <list type="bullet">
+    ///   <item><description>FieldsCount: the number of fields in this file.</description></item>
+    ///   <item><description>FieldName: name of the field as a UTF-8 String.</description></item>
+    ///   <item><description>FieldNumber: the field's number. Note that unlike previous versions of
     ///       Lucene, the fields are not numbered implicitly by their order in the
-    ///       file, instead explicitly.</li>
-    ///   <li>FieldBits: a byte containing field options.
-    ///       <ul>
-    ///         <li>The low-order bit is one for indexed fields, and zero for non-indexed
-    ///             fields.</li>
-    ///         <li>The second lowest-order bit is one for fields that have term vectors
-    ///             stored, and zero for fields without term vectors.</li>
-    ///         <li>If the third lowest order-bit is set (0x4), offsets are stored into
-    ///             the postings list in addition to positions.</li>
-    ///         <li>Fourth bit is unused.</li>
-    ///         <li>If the fifth lowest-order bit is set (0x10), norms are omitted for the
-    ///             indexed field.</li>
-    ///         <li>If the sixth lowest-order bit is set (0x20), payloads are stored for the
-    ///             indexed field.</li>
-    ///         <li>If the seventh lowest-order bit is set (0x40), term frequencies and
-    ///             positions omitted for the indexed field.</li>
-    ///         <li>If the eighth lowest-order bit is set (0x80), positions are omitted for the
-    ///             indexed field.</li>
-    ///       </ul>
-    ///    </li>
-    ///    <li>DocValuesBits: a byte containing per-document value types. The type
+    ///       file, instead explicitly.</description></item>
+    ///   <item><description>FieldBits: a byte containing field options.
+    ///       <list type="bullet">
+    ///         <item><description>The low-order bit is one for indexed fields, and zero for non-indexed
+    ///             fields.</description></item>
+    ///         <item><description>The second lowest-order bit is one for fields that have term vectors
+    ///             stored, and zero for fields without term vectors.</description></item>
+    ///         <item><description>If the third lowest order-bit is set (0x4), offsets are stored into
+    ///             the postings list in addition to positions.</description></item>
+    ///         <item><description>Fourth bit is unused.</description></item>
+    ///         <item><description>If the fifth lowest-order bit is set (0x10), norms are omitted for the
+    ///             indexed field.</description></item>
+    ///         <item><description>If the sixth lowest-order bit is set (0x20), payloads are stored for the
+    ///             indexed field.</description></item>
+    ///         <item><description>If the seventh lowest-order bit is set (0x40), term frequencies and
+    ///             positions omitted for the indexed field.</description></item>
+    ///         <item><description>If the eighth lowest-order bit is set (0x80), positions are omitted for the
+    ///             indexed field.</description></item>
+    ///       </list>
+    ///    </description></item>
+    ///    <item><description>DocValuesBits: a byte containing per-document value types. The type
     ///        recorded as two four-bit integers, with the high-order bits representing
-    ///        <code>norms</code> options, and the low-order bits representing
-    ///        {@code DocValues} options. Each four-bit integer can be decoded as such:
-    ///        <ul>
-    ///          <li>0: no DocValues for this field.</li>
-    ///          <li>1: variable-width signed integers. ({@code Type#VAR_INTS VAR_INTS})</li>
-    ///          <li>2: 32-bit floating point values. ({@code Type#FLOAT_32 FLOAT_32})</li>
-    ///          <li>3: 64-bit floating point values. ({@code Type#FLOAT_64 FLOAT_64})</li>
-    ///          <li>4: fixed-length byte array values. ({@code Type#BYTES_FIXED_STRAIGHT BYTES_FIXED_STRAIGHT})</li>
-    ///          <li>5: fixed-length dereferenced byte array values. ({@code Type#BYTES_FIXED_DEREF BYTES_FIXED_DEREF})</li>
-    ///          <li>6: variable-length byte array values. ({@code Type#BYTES_VAR_STRAIGHT BYTES_VAR_STRAIGHT})</li>
-    ///          <li>7: variable-length dereferenced byte array values. ({@code Type#BYTES_VAR_DEREF BYTES_VAR_DEREF})</li>
-    ///          <li>8: 16-bit signed integers. ({@code Type#FIXED_INTS_16 FIXED_INTS_16})</li>
-    ///          <li>9: 32-bit signed integers. ({@code Type#FIXED_INTS_32 FIXED_INTS_32})</li>
-    ///          <li>10: 64-bit signed integers. ({@code Type#FIXED_INTS_64 FIXED_INTS_64})</li>
-    ///          <li>11: 8-bit signed integers. ({@code Type#FIXED_INTS_8 FIXED_INTS_8})</li>
-    ///          <li>12: fixed-length sorted byte array values. ({@code Type#BYTES_FIXED_SORTED BYTES_FIXED_SORTED})</li>
-    ///          <li>13: variable-length sorted byte array values. ({@code Type#BYTES_VAR_SORTED BYTES_VAR_SORTED})</li>
-    ///        </ul>
-    ///    </li>
-    ///    <li>Attributes: a key-value map of codec-private attributes.</li>
-    /// </ul>
+    ///        <c>norms</c> options, and the low-order bits representing
+    ///        <see cref="Index.DocValues"/> options. Each four-bit integer can be decoded as such:
+    ///        <list type="bullet">
+    ///          <item><description>0: no DocValues for this field.</description></item>
+    ///          <item><description>1: variable-width signed integers. (<see cref="LegacyDocValuesType.VAR_INTS"/>)</description></item>
+    ///          <item><description>2: 32-bit floating point values. (<see cref="LegacyDocValuesType.FLOAT_32"/>)</description></item>
+    ///          <item><description>3: 64-bit floating point values. (<see cref="LegacyDocValuesType.FLOAT_64"/>)</description></item>
+    ///          <item><description>4: fixed-length byte array values. (<see cref="LegacyDocValuesType.BYTES_FIXED_STRAIGHT"/>)</description></item>
+    ///          <item><description>5: fixed-length dereferenced byte array values. (<see cref="LegacyDocValuesType.BYTES_FIXED_DEREF"/>)</description></item>
+    ///          <item><description>6: variable-length byte array values. (<see cref="LegacyDocValuesType.BYTES_VAR_STRAIGHT"/>)</description></item>
+    ///          <item><description>7: variable-length dereferenced byte array values. (<see cref="LegacyDocValuesType.BYTES_VAR_DEREF"/>)</description></item>
+    ///          <item><description>8: 16-bit signed integers. (<see cref="LegacyDocValuesType.FIXED_INTS_16"/>)</description></item>
+    ///          <item><description>9: 32-bit signed integers. (<see cref="LegacyDocValuesType.FIXED_INTS_32"/>)</description></item>
+    ///          <item><description>10: 64-bit signed integers. (<see cref="LegacyDocValuesType.FIXED_INTS_64"/>)</description></item>
+    ///          <item><description>11: 8-bit signed integers. (<see cref="LegacyDocValuesType.FIXED_INTS_8"/>)</description></item>
+    ///          <item><description>12: fixed-length sorted byte array values. (<see cref="LegacyDocValuesType.BYTES_FIXED_SORTED"/>)</description></item>
+    ///          <item><description>13: variable-length sorted byte array values. (<see cref="LegacyDocValuesType.BYTES_VAR_SORTED"/>)</description></item>
+    ///        </list>
+    ///    </description></item>
+    ///    <item><description>Attributes: a key-value map of codec-private attributes.</description></item>
+    /// </list>
     ///
-    /// @lucene.experimental </summary>
-    /// @deprecated Only for reading old 4.0 and 4.1 segments
+    /// @lucene.experimental 
+    /// </summary>
     [Obsolete("Only for reading old 4.0 and 4.1 segments")]
     public class Lucene40FieldInfosFormat : FieldInfosFormat
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosReader.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosReader.cs
index 4805a4b..3f14e3f 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40FieldInfosReader.cs
@@ -34,10 +34,10 @@ namespace Lucene.Net.Codecs.Lucene40
 
     /// <summary>
     /// Lucene 4.0 FieldInfos reader.
-    ///
-    /// @lucene.experimental </summary>
-    /// <seealso cref= Lucene40FieldInfosFormat </seealso>
-    /// @deprecated Only for reading old 4.0 and 4.1 segments
+    /// <para/>
+    /// @lucene.experimental 
+    /// </summary>
+    /// <seealso cref="Lucene40FieldInfosFormat"/>
     [Obsolete("Only for reading old 4.0 and 4.1 segments")]
     internal class Lucene40FieldInfosReader : FieldInfosReader
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40LiveDocsFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40LiveDocsFormat.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40LiveDocsFormat.cs
index cd81003..f26406e 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40LiveDocsFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40LiveDocsFormat.cs
@@ -31,35 +31,35 @@ namespace Lucene.Net.Codecs.Lucene40
 
     /// <summary>
     /// Lucene 4.0 Live Documents Format.
-    /// <p>
-    /// <p>The .del file is optional, and only exists when a segment contains
-    /// deletions.</p>
-    /// <p>Although per-segment, this file is maintained exterior to compound segment
-    /// files.</p>
-    /// <p>Deletions (.del) --&gt; Format,Header,ByteCount,BitCount, Bits | DGaps (depending
-    /// on Format)</p>
-    /// <ul>
-    ///   <li>Format,ByteSize,BitCount --&gt; <seealso cref="DataOutput#writeInt Uint32"/></li>
-    ///   <li>Bits --&gt; &lt;<seealso cref="DataOutput#writeByte Byte"/>&gt; <sup>ByteCount</sup></li>
-    ///   <li>DGaps --&gt; &lt;DGap,NonOnesByte&gt; <sup>NonzeroBytesCount</sup></li>
-    ///   <li>DGap --&gt; <seealso cref="DataOutput#writeVInt VInt"/></li>
-    ///   <li>NonOnesByte --&gt; <seealso cref="DataOutput#writeByte Byte"/></li>
-    ///   <li>Header --&gt; <seealso cref="CodecUtil#writeHeader CodecHeader"/></li>
-    /// </ul>
-    /// <p>Format is 1: indicates cleared DGaps.</p>
-    /// <p>ByteCount indicates the number of bytes in Bits. It is typically
-    /// (SegSize/8)+1.</p>
-    /// <p>BitCount indicates the number of bits that are currently set in Bits.</p>
-    /// <p>Bits contains one bit for each document indexed. When the bit corresponding
+    /// <para/>
+    /// <para>The .del file is optional, and only exists when a segment contains
+    /// deletions.</para>
+    /// <para>Although per-segment, this file is maintained exterior to compound segment
+    /// files.</para>
+    /// <para>Deletions (.del) --&gt; Format,Header,ByteCount,BitCount, Bits | DGaps (depending
+    /// on Format)</para>
+    /// <list type="bullet">
+    ///   <item><description>Format,ByteSize,BitCount --&gt; Uint32 (<see cref="Store.DataOutput.WriteInt32(int)"/>) </description></item>
+    ///   <item><description>Bits --&gt; &lt; Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) &gt; <sup>ByteCount</sup></description></item>
+    ///   <item><description>DGaps --&gt; &lt;DGap,NonOnesByte&gt; <sup>NonzeroBytesCount</sup></description></item>
+    ///   <item><description>DGap --&gt; VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item>
+    ///   <item><description>NonOnesByte --&gt;  Byte(<see cref="Store.DataOutput.WriteByte(byte)"/>) </description></item>
+    ///   <item><description>Header --&gt; CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item>
+    /// </list>
+    /// <para>Format is 1: indicates cleared DGaps.</para>
+    /// <para>ByteCount indicates the number of bytes in Bits. It is typically
+    /// (SegSize/8)+1.</para>
+    /// <para>BitCount indicates the number of bits that are currently set in Bits.</para>
+    /// <para>Bits contains one bit for each document indexed. When the bit corresponding
     /// to a document number is cleared, that document is marked as deleted. Bit ordering
     /// is from least to most significant. Thus, if Bits contains two bytes, 0x00 and
-    /// 0x02, then document 9 is marked as alive (not deleted).</p>
-    /// <p>DGaps represents sparse bit-vectors more efficiently than Bits. It is made
+    /// 0x02, then document 9 is marked as alive (not deleted).</para>
+    /// <para>DGaps represents sparse bit-vectors more efficiently than Bits. It is made
     /// of DGaps on indexes of nonOnes bytes in Bits, and the nonOnes bytes themselves.
-    /// The number of nonOnes bytes in Bits (NonOnesBytesCount) is not stored.</p>
-    /// <p>For example, if there are 8000 bits and only bits 10,12,32 are cleared, DGaps
-    /// would be used:</p>
-    /// <p>(VInt) 1 , (byte) 20 , (VInt) 3 , (Byte) 1</p>
+    /// The number of nonOnes bytes in Bits (NonOnesBytesCount) is not stored.</para>
+    /// <para>For example, if there are 8000 bits and only bits 10,12,32 are cleared, DGaps
+    /// would be used:</para>
+    /// <para>(VInt) 1 , (byte) 20 , (VInt) 3 , (Byte) 1</para>
     /// </summary>
     public class Lucene40LiveDocsFormat : LiveDocsFormat
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40NormsFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40NormsFormat.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40NormsFormat.cs
index 02d97ed..424d63b 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40NormsFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40NormsFormat.cs
@@ -25,18 +25,18 @@ namespace Lucene.Net.Codecs.Lucene40
 
     /// <summary>
     /// Lucene 4.0 Norms Format.
-    /// <p>
+    /// <para/>
     /// Files:
-    /// <ul>
-    ///   <li><tt>.nrm.cfs</tt>: <seealso cref="CompoundFileDirectory compound container"/></li>
-    ///   <li><tt>.nrm.cfe</tt>: <seealso cref="CompoundFileDirectory compound entries"/></li>
-    /// </ul>
+    /// <list type="bullet">
+    ///   <item><description><c>.nrm.cfs</c>: compound container (<see cref="Store.CompoundFileDirectory"/>) </description></item>
+    ///   <item><description><c>.nrm.cfe</c>: compound entries (<see cref="Store.CompoundFileDirectory"/>) </description></item>
+    /// </list>
     /// Norms are implemented as DocValues, so other than file extension, norms are
-    /// written exactly the same way as <seealso cref="Lucene40DocValuesFormat DocValues"/>.
+    /// written exactly the same way as <see cref="Lucene40DocValuesFormat"/>.
+    /// <para/>
+    /// @lucene.experimental
     /// </summary>
-    /// <seealso cref= Lucene40DocValuesFormat
-    /// @lucene.experimental </seealso>
-    /// @deprecated Only for reading old 4.0 and 4.1 segments
+    /// <seealso cref="Lucene40DocValuesFormat"/>
     [Obsolete("Only for reading old 4.0 and 4.1 segments")]
     public class Lucene40NormsFormat : NormsFormat
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsBaseFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsBaseFormat.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsBaseFormat.cs
index ecd85b9..8ecde5b 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsBaseFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsBaseFormat.cs
@@ -23,11 +23,9 @@ namespace Lucene.Net.Codecs.Lucene40
     using SegmentWriteState = Lucene.Net.Index.SegmentWriteState;
 
     /// <summary>
-    /// Provides a <seealso cref="PostingsReaderBase"/> and {@link
-    /// PostingsWriterBase}.
+    /// Provides a <see cref="Codecs.PostingsReaderBase"/> and
+    /// <see cref="Codecs.PostingsWriterBase"/>.
     /// </summary>
-    /// @deprecated Only for reading old 4.0 segments
-
     // TODO: should these also be named / looked up via SPI?
     [Obsolete("Only for reading old 4.0 segments")]
     public sealed class Lucene40PostingsBaseFormat : PostingsBaseFormat

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsFormat.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsFormat.cs
index 440003e..bc0829a 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsFormat.cs
@@ -20,193 +20,187 @@ namespace Lucene.Net.Codecs.Lucene40
      * limitations under the License.
      */
 
-    // javadocs
-    // javadocs
-    // javadocs
     using SegmentReadState = Lucene.Net.Index.SegmentReadState;
     using SegmentWriteState = Lucene.Net.Index.SegmentWriteState;
 
-    // javadocs
-    // javadocs
-
     /// <summary>
     /// Lucene 4.0 Postings format.
-    /// <p>
+    /// <para>
     /// Files:
-    /// <ul>
-    ///   <li><tt>.tim</tt>: <a href="#Termdictionary">Term Dictionary</a></li>
-    ///   <li><tt>.tip</tt>: <a href="#Termindex">Term Index</a></li>
-    ///   <li><tt>.frq</tt>: <a href="#Frequencies">Frequencies</a></li>
-    ///   <li><tt>.prx</tt>: <a href="#Positions">Positions</a></li>
-    /// </ul>
-    /// </p>
-    /// <p>
+    /// <list type="bullet">
+    ///   <item><description><tt>.tim</tt>: <a href="#Termdictionary">Term Dictionary</a></description></item>
+    ///   <item><description><tt>.tip</tt>: <a href="#Termindex">Term Index</a></description></item>
+    ///   <item><description><tt>.frq</tt>: <a href="#Frequencies">Frequencies</a></description></item>
+    ///   <item><description><tt>.prx</tt>: <a href="#Positions">Positions</a></description></item>
+    /// </list>
+    /// </para>
+    /// <para/>
     /// <a name="Termdictionary" id="Termdictionary"></a>
     /// <h3>Term Dictionary</h3>
     ///
-    /// <p>The .tim file contains the list of terms in each
+    /// <para>The .tim file contains the list of terms in each
     /// field along with per-term statistics (such as docfreq)
     /// and pointers to the frequencies, positions and
     /// skip data in the .frq and .prx files.
-    /// See <seealso cref="BlockTreeTermsWriter"/> for more details on the format.
-    /// </p>
+    /// See <see cref="BlockTreeTermsWriter"/> for more details on the format.
+    /// </para>
     ///
-    /// <p>NOTE: The term dictionary can plug into different postings implementations:
+    /// <para>NOTE: The term dictionary can plug into different postings implementations:
     /// the postings writer/reader are actually responsible for encoding
-    /// and decoding the Postings Metadata and Term Metadata sections described here:</p>
-    /// <ul>
-    ///    <li>Postings Metadata --&gt; Header, SkipInterval, MaxSkipLevels, SkipMinimum</li>
-    ///    <li>Term Metadata --&gt; FreqDelta, SkipDelta?, ProxDelta?
-    ///    <li>Header --&gt; <seealso cref="CodecUtil#writeHeader CodecHeader"/></li>
-    ///    <li>SkipInterval,MaxSkipLevels,SkipMinimum --&gt; <seealso cref="DataOutput#writeInt Uint32"/></li>
-    ///    <li>SkipDelta,FreqDelta,ProxDelta --&gt; <seealso cref="DataOutput#writeVLong VLong"/></li>
-    /// </ul>
-    /// <p>Notes:</p>
-    /// <ul>
-    ///    <li>Header is a <seealso cref="CodecUtil#writeHeader CodecHeader"/> storing the version information
-    ///        for the postings.</li>
-    ///    <li>SkipInterval is the fraction of TermDocs stored in skip tables. It is used to accelerate
-    ///        <seealso cref="DocsEnum#advance(int)"/>. Larger values result in smaller indexes, greater
+    /// and decoding the Postings Metadata and Term Metadata sections described here:</para>
+    /// <list type="bullet">
+    ///    <item><description>Postings Metadata --&gt; Header, SkipInterval, MaxSkipLevels, SkipMinimum</description></item>
+    ///    <item><description>Term Metadata --&gt; FreqDelta, SkipDelta?, ProxDelta?</description></item>
+    ///    <item><description>Header --&gt; CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item>
+    ///    <item><description>SkipInterval,MaxSkipLevels,SkipMinimum --&gt; Uint32 (<see cref="Store.DataOutput.WriteInt32(int)"/>) </description></item>
+    ///    <item><description>SkipDelta,FreqDelta,ProxDelta --&gt; VLong (<see cref="Store.DataOutput.WriteVInt64(long)"/>) </description></item>
+    /// </list>
+    /// <para>Notes:</para>
+    /// <list type="bullet">
+    ///    <item><description>Header is a CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>)  storing the version information
+    ///        for the postings.</description></item>
+    ///    <item><description>SkipInterval is the fraction of TermDocs stored in skip tables. It is used to accelerate
+    ///        <see cref="Search.DocIdSetIterator.Advance(int)"/>. Larger values result in smaller indexes, greater
     ///        acceleration, but fewer accelerable cases, while smaller values result in bigger indexes,
     ///        less acceleration (in case of a small value for MaxSkipLevels) and more accelerable cases.
-    ///        </li>
-    ///    <li>MaxSkipLevels is the max. number of skip levels stored for each term in the .frq file. A
+    ///        </description></item>
+    ///    <item><description>MaxSkipLevels is the max. number of skip levels stored for each term in the .frq file. A
     ///        low value results in smaller indexes but less acceleration, a larger value results in
     ///        slightly larger indexes but greater acceleration. See format of .frq file for more
-    ///        information about skip levels.</li>
-    ///    <li>SkipMinimum is the minimum document frequency a term must have in order to write any
-    ///        skip data at all.</li>
-    ///    <li>FreqDelta determines the position of this term's TermFreqs within the .frq
+    ///        information about skip levels.</description></item>
+    ///    <item><description>SkipMinimum is the minimum document frequency a term must have in order to write any
+    ///        skip data at all.</description></item>
+    ///    <item><description>FreqDelta determines the position of this term's TermFreqs within the .frq
     ///        file. In particular, it is the difference between the position of this term's
     ///        data in that file and the position of the previous term's data (or zero, for
-    ///        the first term in the block).</li>
-    ///    <li>ProxDelta determines the position of this term's TermPositions within the
+    ///        the first term in the block).</description></item>
+    ///    <item><description>ProxDelta determines the position of this term's TermPositions within the
     ///        .prx file. In particular, it is the difference between the position of this
     ///        term's data in that file and the position of the previous term's data (or zero,
     ///        for the first term in the block. For fields that omit position data, this will
-    ///        be 0 since prox information is not stored.</li>
-    ///    <li>SkipDelta determines the position of this term's SkipData within the .frq
+    ///        be 0 since prox information is not stored.</description></item>
+    ///    <item><description>SkipDelta determines the position of this term's SkipData within the .frq
     ///        file. In particular, it is the number of bytes after TermFreqs that the
     ///        SkipData starts. In other words, it is the length of the TermFreq data.
-    ///        SkipDelta is only stored if DocFreq is not smaller than SkipMinimum.</li>
-    /// </ul>
+    ///        SkipDelta is only stored if DocFreq is not smaller than SkipMinimum.</description></item>
+    /// </list>
     /// <a name="Termindex" id="Termindex"></a>
     /// <h3>Term Index</h3>
-    /// <p>The .tip file contains an index into the term dictionary, so that it can be
-    /// accessed randomly.  See <seealso cref="BlockTreeTermsWriter"/> for more details on the format.</p>
+    /// <para>The .tip file contains an index into the term dictionary, so that it can be
+    /// accessed randomly.  See <see cref="BlockTreeTermsWriter"/> for more details on the format.</para>
     /// <a name="Frequencies" id="Frequencies"></a>
     /// <h3>Frequencies</h3>
-    /// <p>The .frq file contains the lists of documents which contain each term, along
+    /// <para>The .frq file contains the lists of documents which contain each term, along
     /// with the frequency of the term in that document (except when frequencies are
-    /// omitted: <seealso cref="IndexOptions#DOCS_ONLY"/>).</p>
-    /// <ul>
-    ///   <li>FreqFile (.frq) --&gt; Header, &lt;TermFreqs, SkipData?&gt; <sup>TermCount</sup></li>
-    ///   <li>Header --&gt; <seealso cref="CodecUtil#writeHeader CodecHeader"/></li>
-    ///   <li>TermFreqs --&gt; &lt;TermFreq&gt; <sup>DocFreq</sup></li>
-    ///   <li>TermFreq --&gt; DocDelta[, Freq?]</li>
-    ///   <li>SkipData --&gt; &lt;&lt;SkipLevelLength, SkipLevel&gt;
-    ///       <sup>NumSkipLevels-1</sup>, SkipLevel&gt; &lt;SkipDatum&gt;</li>
-    ///   <li>SkipLevel --&gt; &lt;SkipDatum&gt; <sup>DocFreq/(SkipInterval^(Level +
-    ///       1))</sup></li>
-    ///   <li>SkipDatum --&gt;
-    ///       DocSkip,PayloadLength?,OffsetLength?,FreqSkip,ProxSkip,SkipChildLevelPointer?</li>
-    ///   <li>DocDelta,Freq,DocSkip,PayloadLength,OffsetLength,FreqSkip,ProxSkip --&gt; <seealso cref="DataOutput#writeVInt VInt"/></li>
-    ///   <li>SkipChildLevelPointer --&gt; <seealso cref="DataOutput#writeVLong VLong"/></li>
-    /// </ul>
-    /// <p>TermFreqs are ordered by term (the term is implicit, from the term dictionary).</p>
-    /// <p>TermFreq entries are ordered by increasing document number.</p>
-    /// <p>DocDelta: if frequencies are indexed, this determines both the document
+    /// omitted: <see cref="Index.IndexOptions.DOCS_ONLY"/>).</para>
+    /// <list type="bullet">
+    ///   <item><description>FreqFile (.frq) --&gt; Header, &lt;TermFreqs, SkipData?&gt; <sup>TermCount</sup></description></item>
+    ///   <item><description>Header --&gt; CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item>
+    ///   <item><description>TermFreqs --&gt; &lt;TermFreq&gt; <sup>DocFreq</sup></description></item>
+    ///   <item><description>TermFreq --&gt; DocDelta[, Freq?]</description></item>
+    ///   <item><description>SkipData --&gt; &lt;&lt;SkipLevelLength, SkipLevel&gt;
+    ///       <sup>NumSkipLevels-1</sup>, SkipLevel&gt; &lt;SkipDatum&gt;</description></item>
+    ///   <item><description>SkipLevel --&gt; &lt;SkipDatum&gt; <sup>DocFreq/(SkipInterval^(Level +
+    ///       1))</sup></description></item>
+    ///   <item><description>SkipDatum --&gt;
+    ///       DocSkip,PayloadLength?,OffsetLength?,FreqSkip,ProxSkip,SkipChildLevelPointer?</description></item>
+    ///   <item><description>DocDelta,Freq,DocSkip,PayloadLength,OffsetLength,FreqSkip,ProxSkip --&gt; VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item>
+    ///   <item><description>SkipChildLevelPointer --&gt; VLong (<see cref="Store.DataOutput.WriteVInt64(long)"/>) </description></item>
+    /// </list>
+    /// <para>TermFreqs are ordered by term (the term is implicit, from the term dictionary).</para>
+    /// <para>TermFreq entries are ordered by increasing document number.</para>
+    /// <para>DocDelta: if frequencies are indexed, this determines both the document
     /// number and the frequency. In particular, DocDelta/2 is the difference between
     /// this document number and the previous document number (or zero when this is the
     /// first document in a TermFreqs). When DocDelta is odd, the frequency is one.
     /// When DocDelta is even, the frequency is read as another VInt. If frequencies
     /// are omitted, DocDelta contains the gap (not multiplied by 2) between document
-    /// numbers and no frequency information is stored.</p>
-    /// <p>For example, the TermFreqs for a term which occurs once in document seven
+    /// numbers and no frequency information is stored.</para>
+    /// <para>For example, the TermFreqs for a term which occurs once in document seven
     /// and three times in document eleven, with frequencies indexed, would be the
-    /// following sequence of VInts:</p>
-    /// <p>15, 8, 3</p>
-    /// <p>If frequencies were omitted (<seealso cref="IndexOptions#DOCS_ONLY"/>) it would be this
-    /// sequence of VInts instead:</p>
-    /// <p>7,4</p>
-    /// <p>DocSkip records the document number before every SkipInterval <sup>th</sup>
+    /// following sequence of VInts:</para>
+    /// <para>15, 8, 3</para>
+    /// <para>If frequencies were omitted (<see cref="Index.IndexOptions.DOCS_ONLY"/>) it would be this
+    /// sequence of VInts instead:</para>
+    /// <para>7,4</para>
+    /// <para>DocSkip records the document number before every SkipInterval <sup>th</sup>
     /// document in TermFreqs. If payloads and offsets are disabled for the term's field, then
     /// DocSkip represents the difference from the previous value in the sequence. If
     /// payloads and/or offsets are enabled for the term's field, then DocSkip/2 represents the
     /// difference from the previous value in the sequence. In this case when
     /// DocSkip is odd, then PayloadLength and/or OffsetLength are stored indicating the length of
-    /// the last payload/offset before the SkipInterval<sup>th</sup> document in TermPositions.</p>
-    /// <p>PayloadLength indicates the length of the last payload.</p>
-    /// <p>OffsetLength indicates the length of the last offset (endOffset-startOffset).</p>
-    /// <p>
+    /// the last payload/offset before the SkipInterval<sup>th</sup> document in TermPositions.</para>
+    /// <para>PayloadLength indicates the length of the last payload.</para>
+    /// <para>OffsetLength indicates the length of the last offset (endOffset-startOffset).</para>
+    /// <para>
     /// FreqSkip and ProxSkip record the position of every SkipInterval <sup>th</sup>
     /// entry in FreqFile and ProxFile, respectively. File positions are relative to
     /// the start of TermFreqs and Positions, to the previous SkipDatum in the
-    /// sequence.</p>
-    /// <p>For example, if DocFreq=35 and SkipInterval=16, then there are two SkipData
+    /// sequence.</para>
+    /// <para>For example, if DocFreq=35 and SkipInterval=16, then there are two SkipData
     /// entries, containing the 15 <sup>th</sup> and 31 <sup>st</sup> document numbers
     /// in TermFreqs. The first FreqSkip names the number of bytes after the beginning
     /// of TermFreqs that the 16 <sup>th</sup> SkipDatum starts, and the second the
     /// number of bytes after that that the 32 <sup>nd</sup> starts. The first ProxSkip
     /// names the number of bytes after the beginning of Positions that the 16
     /// <sup>th</sup> SkipDatum starts, and the second the number of bytes after that
-    /// that the 32 <sup>nd</sup> starts.</p>
-    /// <p>Each term can have multiple skip levels. The amount of skip levels for a
+    /// that the 32 <sup>nd</sup> starts.</para>
+    /// <para>Each term can have multiple skip levels. The amount of skip levels for a
     /// term is NumSkipLevels = Min(MaxSkipLevels,
     /// floor(log(DocFreq/log(SkipInterval)))). The number of SkipData entries for a
     /// skip level is DocFreq/(SkipInterval^(Level + 1)), whereas the lowest skip level
-    /// is Level=0.<br>
+    /// is Level=0.
+    /// <para/>
     /// Example: SkipInterval = 4, MaxSkipLevels = 2, DocFreq = 35. Then skip level 0
     /// has 8 SkipData entries, containing the 3<sup>rd</sup>, 7<sup>th</sup>,
     /// 11<sup>th</sup>, 15<sup>th</sup>, 19<sup>th</sup>, 23<sup>rd</sup>,
     /// 27<sup>th</sup>, and 31<sup>st</sup> document numbers in TermFreqs. Skip level
     /// 1 has 2 SkipData entries, containing the 15<sup>th</sup> and 31<sup>st</sup>
-    /// document numbers in TermFreqs.<br>
+    /// document numbers in TermFreqs.
+    /// <para/>
     /// The SkipData entries on all upper levels &gt; 0 contain a SkipChildLevelPointer
     /// referencing the corresponding SkipData entry in level-1. In the example has
     /// entry 15 on level 1 a pointer to entry 15 on level 0 and entry 31 on level 1 a
     /// pointer to entry 31 on level 0.
-    /// </p>
+    /// </para>
     /// <a name="Positions" id="Positions"></a>
     /// <h3>Positions</h3>
-    /// <p>The .prx file contains the lists of positions that each term occurs at
+    /// <para>The .prx file contains the lists of positions that each term occurs at
     /// within documents. Note that fields omitting positional data do not store
     /// anything into this file, and if all fields in the index omit positional data
-    /// then the .prx file will not exist.</p>
-    /// <ul>
-    ///   <li>ProxFile (.prx) --&gt; Header, &lt;TermPositions&gt; <sup>TermCount</sup></li>
-    ///   <li>Header --&gt; <seealso cref="CodecUtil#writeHeader CodecHeader"/></li>
-    ///   <li>TermPositions --&gt; &lt;Positions&gt; <sup>DocFreq</sup></li>
-    ///   <li>Positions --&gt; &lt;PositionDelta,PayloadLength?,OffsetDelta?,OffsetLength?,PayloadData?&gt; <sup>Freq</sup></li>
-    ///   <li>PositionDelta,OffsetDelta,OffsetLength,PayloadLength --&gt; <seealso cref="DataOutput#writeVInt VInt"/></li>
-    ///   <li>PayloadData --&gt; <seealso cref="DataOutput#writeByte byte"/><sup>PayloadLength</sup></li>
-    /// </ul>
-    /// <p>TermPositions are ordered by term (the term is implicit, from the term dictionary).</p>
-    /// <p>Positions entries are ordered by increasing document number (the document
-    /// number is implicit from the .frq file).</p>
-    /// <p>PositionDelta is, if payloads are disabled for the term's field, the
+    /// then the .prx file will not exist.</para>
+    /// <list type="bullet">
+    ///   <item><description>ProxFile (.prx) --&gt; Header, &lt;TermPositions&gt; <sup>TermCount</sup></description></item>
+    ///   <item><description>Header --&gt; CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item>
+    ///   <item><description>TermPositions --&gt; &lt;Positions&gt; <sup>DocFreq</sup></description></item>
+    ///   <item><description>Positions --&gt; &lt;PositionDelta,PayloadLength?,OffsetDelta?,OffsetLength?,PayloadData?&gt; <sup>Freq</sup></description></item>
+    ///   <item><description>PositionDelta,OffsetDelta,OffsetLength,PayloadLength --&gt; VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item>
+    ///   <item><description>PayloadData --&gt; byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) <sup>PayloadLength</sup></description></item>
+    /// </list>
+    /// <para>TermPositions are ordered by term (the term is implicit, from the term dictionary).</para>
+    /// <para>Positions entries are ordered by increasing document number (the document
+    /// number is implicit from the .frq file).</para>
+    /// <para>PositionDelta is, if payloads are disabled for the term's field, the
     /// difference between the position of the current occurrence in the document and
     /// the previous occurrence (or zero, if this is the first occurrence in this
     /// document). If payloads are enabled for the term's field, then PositionDelta/2
     /// is the difference between the current and the previous position. If payloads
     /// are enabled and PositionDelta is odd, then PayloadLength is stored, indicating
-    /// the length of the payload at the current term position.</p>
-    /// <p>For example, the TermPositions for a term which occurs as the fourth term in
+    /// the length of the payload at the current term position.</para>
+    /// <para>For example, the TermPositions for a term which occurs as the fourth term in
     /// one document, and as the fifth and ninth term in a subsequent document, would
-    /// be the following sequence of VInts (payloads disabled):</p>
-    /// <p>4, 5, 4</p>
-    /// <p>PayloadData is metadata associated with the current term position. If
+    /// be the following sequence of VInts (payloads disabled):</para>
+    /// <para>4, 5, 4</para>
+    /// <para>PayloadData is metadata associated with the current term position. If
     /// PayloadLength is stored at the current position, then it indicates the length
     /// of this payload. If PayloadLength is not stored, then this payload has the same
-    /// length as the payload at the previous position.</p>
-    /// <p>OffsetDelta/2 is the difference between this position's startOffset from the
+    /// length as the payload at the previous position.</para>
+    /// <para>OffsetDelta/2 is the difference between this position's startOffset from the
     /// previous occurrence (or zero, if this is the first occurrence in this document).
     /// If OffsetDelta is odd, then the length (endOffset-startOffset) differs from the
     /// previous occurrence and an OffsetLength follows. Offset data is only written for
-    /// <seealso cref="IndexOptions#DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/>.</p>
+    /// <see cref="Index.IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/>.</para>
     /// </summary>
-    ///  @deprecated Only for reading old 4.0 segments
-
     // TODO: this class could be created by wrapping
     // BlockTreeTermsDict around Lucene40PostingsBaseFormat; ie
     // we should not duplicate the code from that class here:
@@ -215,16 +209,16 @@ namespace Lucene.Net.Codecs.Lucene40
     public class Lucene40PostingsFormat : PostingsFormat
     {
         /// <summary>
-        /// minimum items (terms or sub-blocks) per block for BlockTree </summary>
+        /// Minimum items (terms or sub-blocks) per block for BlockTree. </summary>
         protected readonly int m_minBlockSize;
 
         /// <summary>
-        /// maximum items (terms or sub-blocks) per block for BlockTree </summary>
+        /// Maximum items (terms or sub-blocks) per block for BlockTree. </summary>
         protected readonly int m_maxBlockSize;
 
         /// <summary>
-        /// Creates {@code Lucene40PostingsFormat} with default
-        ///  settings.
+        /// Creates <see cref="Lucene40PostingsFormat"/> with default
+        /// settings.
         /// </summary>
         public Lucene40PostingsFormat()
             : this(BlockTreeTermsWriter.DEFAULT_MIN_BLOCK_SIZE, BlockTreeTermsWriter.DEFAULT_MAX_BLOCK_SIZE)
@@ -232,10 +226,10 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Creates {@code Lucene40PostingsFormat} with custom
-        ///  values for {@code minBlockSize} and {@code
-        ///  maxBlockSize} passed to block terms dictionary. </summary>
-        ///  <seealso cref= BlockTreeTermsWriter#BlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int)  </seealso>
+        /// Creates <see cref="Lucene40PostingsFormat"/> with custom
+        /// values for <paramref name="minBlockSize"/> and 
+        /// <paramref name="maxBlockSize"/> passed to block terms dictionary. </summary>
+        ///  <seealso cref="BlockTreeTermsWriter.BlockTreeTermsWriter(SegmentWriteState,PostingsWriterBase,int,int)"/>
         private Lucene40PostingsFormat(int minBlockSize, int maxBlockSize)
             : base()
         {
@@ -270,11 +264,11 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// Extension of freq postings file </summary>
+        /// Extension of freq postings file. </summary>
         internal static readonly string FREQ_EXTENSION = "frq";
 
         /// <summary>
-        /// Extension of prox postings file </summary>
+        /// Extension of prox postings file. </summary>
         internal static readonly string PROX_EXTENSION = "prx";
 
         public override string ToString()

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsReader.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsReader.cs
index 29516db..12fb35d 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40PostingsReader.cs
@@ -42,8 +42,7 @@ namespace Lucene.Net.Codecs.Lucene40
     /// Concrete class that reads the 4.0 frq/prox
     /// postings format.
     /// </summary>
-    ///  <seealso cref= Lucene40PostingsFormat </seealso>
-    ///  @deprecated Only for reading old 4.0 segments
+    /// <seealso cref="Lucene40PostingsFormat"/>
     [Obsolete("Only for reading old 4.0 segments")]
     public class Lucene40PostingsReader : PostingsReaderBase
     {
@@ -958,8 +957,8 @@ namespace Lucene.Net.Codecs.Lucene40
             }
 
             /// <summary>
-            /// Returns the payload at this position, or null if no
-            ///  payload was indexed.
+            /// Returns the payload at this position, or <c>null</c> if no
+            /// payload was indexed.
             /// </summary>
             public override BytesRef GetPayload()
             {
@@ -1263,8 +1262,8 @@ namespace Lucene.Net.Codecs.Lucene40
             }
 
             /// <summary>
-            /// Returns the payload at this position, or null if no
-            ///  payload was indexed.
+            /// Returns the payload at this position, or <c>null</c> if no
+            /// payload was indexed.
             /// </summary>
             public override BytesRef GetPayload()
             {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoFormat.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoFormat.cs
index c3ce3c9..8fb9084 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoFormat.cs
@@ -19,54 +19,49 @@ namespace Lucene.Net.Codecs.Lucene40
      * limitations under the License.
      */
 
-    // javadocs
-    using SegmentInfo = Lucene.Net.Index.SegmentInfo; // javadocs
-
-    // javadocs
-    // javadocs
+    using SegmentInfo = Lucene.Net.Index.SegmentInfo;
 
     /// <summary>
     /// Lucene 4.0 Segment info format.
-    /// <p>
+    /// <para>
     /// Files:
-    /// <ul>
-    ///   <li><tt>.si</tt>: Header, SegVersion, SegSize, IsCompoundFile, Diagnostics, Attributes, Files
-    /// </ul>
-    /// </p>
+    /// <list type="bullet">
+    ///   <item><description><tt>.si</tt>: Header, SegVersion, SegSize, IsCompoundFile, Diagnostics, Attributes, Files</description></item>
+    /// </list>
+    /// </para>
     /// Data types:
-    /// <p>
-    /// <ul>
-    ///   <li>Header --&gt; <seealso cref="CodecUtil#writeHeader CodecHeader"/></li>
-    ///   <li>SegSize --&gt; <seealso cref="DataOutput#writeInt Int32"/></li>
-    ///   <li>SegVersion --&gt; <seealso cref="DataOutput#writeString String"/></li>
-    ///   <li>Files --&gt; <seealso cref="DataOutput#writeStringSet Set&lt;String&gt;"/></li>
-    ///   <li>Diagnostics, Attributes --&gt; <seealso cref="DataOutput#writeStringStringMap Map&lt;String,String&gt;"/></li>
-    ///   <li>IsCompoundFile --&gt; <seealso cref="DataOutput#writeByte Int8"/></li>
-    /// </ul>
-    /// </p>
+    /// <para>
+    /// <list type="bullet">
+    ///   <item><description>Header --&gt; CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item>
+    ///   <item><description>SegSize --&gt; Int32 (<see cref="Store.DataOutput.WriteInt32(int)"/>) </description></item>
+    ///   <item><description>SegVersion --&gt; String (<see cref="Store.DataOutput.WriteString(string)"/>) </description></item>
+    ///   <item><description>Files --&gt; ISet&lt;String&gt; (<see cref="Store.DataOutput.WriteStringSet(System.Collections.Generic.ISet{string})"/>) </description></item>
+    ///   <item><description>Diagnostics, Attributes --&gt; IDictionary&lt;String,String&gt; (<see cref="Store.DataOutput.WriteStringStringMap(System.Collections.Generic.IDictionary{string, string})"/>) </description></item>
+    ///   <item><description>IsCompoundFile --&gt; Int8 (<see cref="Store.DataOutput.WriteByte(byte)"/>) </description></item>
+    /// </list>
+    /// </para>
     /// Field Descriptions:
-    /// <p>
-    /// <ul>
-    ///   <li>SegVersion is the code version that created the segment.</li>
-    ///   <li>SegSize is the number of documents contained in the segment index.</li>
-    ///   <li>IsCompoundFile records whether the segment is written as a compound file or
+    /// <para>
+    /// <list type="bullet">
+    ///   <item><description>SegVersion is the code version that created the segment.</description></item>
+    ///   <item><description>SegSize is the number of documents contained in the segment index.</description></item>
+    ///   <item><description>IsCompoundFile records whether the segment is written as a compound file or
     ///       not. If this is -1, the segment is not a compound file. If it is 1, the segment
-    ///       is a compound file.</li>
-    ///   <li>Checksum contains the CRC32 checksum of all bytes in the segments_N file up
-    ///       until the checksum. this is used to verify integrity of the file on opening the
-    ///       index.</li>
-    ///   <li>The Diagnostics Map is privately written by <seealso cref="IndexWriter"/>, as a debugging aid,
+    ///       is a compound file.</description></item>
+    ///   <item><description>Checksum contains the CRC32 checksum of all bytes in the segments_N file up
+    ///       until the checksum. This is used to verify integrity of the file on opening the
+    ///       index.</description></item>
+    ///   <item><description>The Diagnostics Map is privately written by <see cref="Index.IndexWriter"/>, as a debugging aid,
     ///       for each segment it creates. It includes metadata like the current Lucene
-    ///       version, OS, Java version, why the segment was created (merge, flush,
-    ///       addIndexes), etc.</li>
-    ///   <li>Attributes: a key-value map of codec-private attributes.</li>
-    ///   <li>Files is a list of files referred to by this segment.</li>
-    /// </ul>
-    /// </p>
+    ///       version, OS, .NET/Java version, why the segment was created (merge, flush,
+    ///       addIndexes), etc.</description></item>
+    ///   <item><description>Attributes: a key-value map of codec-private attributes.</description></item>
+    ///   <item><description>Files is a list of files referred to by this segment.</description></item>
+    /// </list>
+    /// </para>
+    /// @lucene.experimental
     /// </summary>
-    /// <seealso cref= SegmentInfos
-    /// @lucene.experimental </seealso>
-    /// @deprecated Only for reading old 4.0-4.5 segments, and supporting IndexWriter.addIndexes
+    /// <seealso cref="Index.SegmentInfos"/>
     [Obsolete("Only for reading old 4.0-4.5 segments, and supporting IndexWriter.AddIndexes()")]
     public class Lucene40SegmentInfoFormat : SegmentInfoFormat
     {
@@ -98,7 +93,7 @@ namespace Lucene.Net.Codecs.Lucene40
         }
 
         /// <summary>
-        /// File extension used to store <seealso cref="SegmentInfo"/>. </summary>
+        /// File extension used to store <see cref="SegmentInfo"/>. </summary>
         public readonly static string SI_EXTENSION = "si";
 
         internal readonly static string CODEC_NAME = "Lucene40SegmentInfo";

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoReader.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoReader.cs
index aec213d..07b728f 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoReader.cs
@@ -29,11 +29,11 @@ namespace Lucene.Net.Codecs.Lucene40
     using SegmentInfo = Lucene.Net.Index.SegmentInfo;
 
     /// <summary>
-    /// Lucene 4.0 implementation of <seealso cref="SegmentInfoReader"/>.
+    /// Lucene 4.0 implementation of <see cref="SegmentInfoReader"/>.
+    /// <para/>
+    /// @lucene.experimental 
     /// </summary>
-    /// <seealso cref= Lucene40SegmentInfoFormat
-    /// @lucene.experimental </seealso>
-    /// @deprecated Only for reading old 4.0-4.5 segments
+    /// <seealso cref="Lucene40SegmentInfoFormat"/>
     [Obsolete("Only for reading old 4.0-4.5 segments")]
     public class Lucene40SegmentInfoReader : SegmentInfoReader
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoWriter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoWriter.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoWriter.cs
index a2d2925..ef8807f 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoWriter.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40SegmentInfoWriter.cs
@@ -29,10 +29,11 @@ namespace Lucene.Net.Codecs.Lucene40
     using SegmentInfo = Lucene.Net.Index.SegmentInfo;
 
     /// <summary>
-    /// Lucene 4.0 implementation of <seealso cref="SegmentInfoWriter"/>.
+    /// Lucene 4.0 implementation of <see cref="SegmentInfoWriter"/>.
+    /// <para/>
+    /// @lucene.experimental
     /// </summary>
-    /// <seealso cref= Lucene40SegmentInfoFormat
-    /// @lucene.experimental </seealso>
+    /// <seealso cref="Lucene40SegmentInfoFormat"/>
     [Obsolete]
     public class Lucene40SegmentInfoWriter : SegmentInfoWriter
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40SkipListReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40SkipListReader.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40SkipListReader.cs
index cacafe5..1dcec33 100644
--- a/src/Lucene.Net/Codecs/Lucene40/Lucene40SkipListReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40SkipListReader.cs
@@ -26,8 +26,7 @@ namespace Lucene.Net.Codecs.Lucene40
     /// Implements the skip list reader for the 4.0 posting list format
     /// that stores positions and payloads.
     /// </summary>
-    /// <seealso cref= Lucene40PostingsFormat </seealso>
-    /// @deprecated Only for reading old 4.0 segments
+    /// <seealso cref="Lucene40PostingsFormat"/>
     [Obsolete("Only for reading old 4.0 segments")]
     public class Lucene40SkipListReader : MultiLevelSkipListReader
     {
@@ -72,7 +71,7 @@ namespace Lucene.Net.Codecs.Lucene40
 
         /// <summary>
         /// Returns the freq pointer of the doc to which the last call of
-        /// <seealso cref="MultiLevelSkipListReader#skipTo(int)"/> has skipped.
+        /// <see cref="MultiLevelSkipListReader.SkipTo(int)"/> has skipped.
         /// </summary>
         public virtual long FreqPointer
         {
@@ -84,7 +83,7 @@ namespace Lucene.Net.Codecs.Lucene40
 
         /// <summary>
         /// Returns the prox pointer of the doc to which the last call of
-        /// <seealso cref="MultiLevelSkipListReader#skipTo(int)"/> has skipped.
+        /// <see cref="MultiLevelSkipListReader.SkipTo(int)"/> has skipped.
         /// </summary>
         public virtual long ProxPointer
         {
@@ -96,7 +95,7 @@ namespace Lucene.Net.Codecs.Lucene40
 
         /// <summary>
         /// Returns the payload length of the payload stored just before
-        /// the doc to which the last call of <seealso cref="MultiLevelSkipListReader#skipTo(int)"/>
+        /// the doc to which the last call of <see cref="MultiLevelSkipListReader.SkipTo(int)"/>
         /// has skipped.
         /// </summary>
         public virtual int PayloadLength
@@ -109,7 +108,7 @@ namespace Lucene.Net.Codecs.Lucene40
 
         /// <summary>
         /// Returns the offset length (endOffset-startOffset) of the position stored just before
-        /// the doc to which the last call of <seealso cref="MultiLevelSkipListReader#skipTo(int)"/>
+        /// the doc to which the last call of <see cref="MultiLevelSkipListReader.SkipTo(int)"/>
         /// has skipped.
         /// </summary>
         public virtual int OffsetLength


Mime
View raw message