http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsFormat.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsFormat.cs index 81fea3e..0959ff0 100644 --- a/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsFormat.cs +++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsFormat.cs @@ -17,7 +17,6 @@ namespace Lucene.Net.Codecs.Lucene40 * limitations under the License. */ - // javadocs using Directory = Lucene.Net.Store.Directory; using FieldInfos = Lucene.Net.Index.FieldInfos; using IOContext = Lucene.Net.Store.IOContext; @@ -25,53 +24,54 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Lucene 4.0 Stored Fields Format. - /// <p>Stored fields are represented by two files:</p> - /// <ol> - /// <li><a name="field_index" id="field_index"></a> - /// <p>The field index, or <tt>.fdx</tt> file.</p> - /// <p>this is used to find the location within the field data file of the fields - /// of a particular document. Because it contains fixed-length data, this file may - /// be easily randomly accessed. The position of document <i>n</i> 's field data is - /// the <seealso cref="DataOutput#writeLong Uint64"/> at <i>n*8</i> in this file.</p> - /// <p>this contains, for each document, a pointer to its field data, as - /// follows:</p> - /// <ul> - /// <li>FieldIndex (.fdx) --> <Header>, <FieldValuesPosition> <sup>SegSize</sup></li> - /// <li>Header --> <seealso cref="CodecUtil#writeHeader CodecHeader"/></li> - /// <li>FieldValuesPosition --> <seealso cref="DataOutput#writeLong Uint64"/></li> - /// </ul> - /// </li> - /// <li> - /// <p><a name="field_data" id="field_data"></a>The field data, or <tt>.fdt</tt> file.</p> - /// <p>this contains the stored fields of each document, as follows:</p> - /// <ul> - /// <li>FieldData (.fdt) --> <Header>, <DocFieldData> <sup>SegSize</sup></li> - /// <li>Header --> <seealso cref="CodecUtil#writeHeader CodecHeader"/></li> - /// <li>DocFieldData --> FieldCount, <FieldNum, Bits, Value> - /// <sup>FieldCount</sup></li> - /// <li>FieldCount --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>FieldNum --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>Bits --> <seealso cref="DataOutput#writeByte Byte"/></li> - /// <ul> - /// <li>low order bit reserved.</li> - /// <li>second bit is one for fields containing binary data</li> - /// <li>third bit reserved.</li> - /// <li>4th to 6th bit (mask: 0x7<<3) define the type of a numeric field: - /// <ul> - /// <li>all bits in mask are cleared if no numeric field at all</li> - /// <li>1<<3: Value is Int</li> - /// <li>2<<3: Value is Long</li> - /// <li>3<<3: Value is Int as Float (as of <seealso cref="Float#intBitsToFloat(int)"/></li> - /// <li>4<<3: Value is Long as Double (as of <seealso cref="Double#longBitsToDouble(long)"/></li> - /// </ul> - /// </li> - /// </ul> - /// <li>Value --> String | BinaryValue | Int | Long (depending on Bits)</li> - /// <li>BinaryValue --> ValueSize, <<seealso cref="DataOutput#writeByte Byte"/>>^ValueSize</li> - /// <li>ValueSize --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// </li> - /// </ul> - /// </ol> + /// <para>Stored fields are represented by two files:</para> + /// <list type="number"> + /// <item><description><a name="field_index" id="field_index"></a> + /// <para>The field index, or <c>.fdx</c> file.</para> + /// <para>This is used to find the location within the field data file of the fields + /// of a particular document. Because it contains fixed-length data, this file may + /// be easily randomly accessed. The position of document <i>n</i> 's field data is + /// the Uint64 (<see cref="Store.DataOutput.WriteInt64(long)"/>) at <i>n*8</i> in this file.</para> + /// <para>This contains, for each document, a pointer to its field data, as + /// follows:</para> + /// <list type="bullet"> + /// <item><description>FieldIndex (.fdx) --> <Header>, <FieldValuesPosition> <sup>SegSize</sup></description></item> + /// <item><description>Header --> CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item> + /// <item><description>FieldValuesPosition --> Uint64 (<see cref="Store.DataOutput.WriteInt64(long)"/>) </description></item> + /// </list> + /// </description></item> + /// <item><description> + /// <para><a name="field_data" id="field_data"></a>The field data, or <c>.fdt</c> file.</para> + /// <para>This contains the stored fields of each document, as follows:</para> + /// <list type="bullet"> + /// <item><description>FieldData (.fdt) --> <Header>, <DocFieldData> <sup>SegSize</sup></description></item> + /// <item><description>Header --> CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item> + /// <item><description>DocFieldData --> FieldCount, <FieldNum, Bits, Value> + /// <sup>FieldCount</sup></description></item> + /// <item><description>FieldCount --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>FieldNum --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>Bits --> Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) + /// <list type="bullet"> + /// <item><description>low order bit reserved.</description></item> + /// <item><description>second bit is one for fields containing binary data</description></item> + /// <item><description>third bit reserved.</description></item> + /// <item><description>4th to 6th bit (mask: 0x7<<3) define the type of a numeric field: + /// <list type="bullet"> + /// <item><description>all bits in mask are cleared if no numeric field at all</description></item> + /// <item><description>1<<3: Value is Int</description></item> + /// <item><description>2<<3: Value is Long</description></item> + /// <item><description>3<<3: Value is Int as Float (as of <see cref="Support.Number.Int32BitsToSingle(int)"/></description></item> + /// <item><description>4<<3: Value is Long as Double (as of <see cref="System.BitConverter.Int64BitsToDouble(long)"/></description></item> + /// </list> + /// </description></item> + /// </list> + /// </description></item> + /// <item><description>Value --> String | BinaryValue | Int | Long (depending on Bits)</description></item> + /// <item><description>BinaryValue --> ValueSize, < Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) >^ValueSize</description></item> + /// <item><description>ValueSize --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// </list> + /// </description></item> + /// </list> /// @lucene.experimental /// </summary> public class Lucene40StoredFieldsFormat : StoredFieldsFormat
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsReader.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsReader.cs index f3064fe..2ce0261 100644 --- a/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsReader.cs +++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsReader.cs @@ -35,11 +35,12 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Class responsible for access to stored document fields. - /// <p/> + /// <para/> /// It uses <segment>.fdt and <segment>.fdx; files. + /// <para/> + /// @lucene.internal /// </summary> - /// <seealso cref= Lucene40StoredFieldsFormat - /// @lucene.internal </seealso> + /// <seealso cref="Lucene40StoredFieldsFormat"/> public sealed class Lucene40StoredFieldsReader : StoredFieldsReader, IDisposable { private readonly FieldInfos fieldInfos; @@ -51,10 +52,10 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Returns a cloned FieldsReader that shares open - /// IndexInputs with the original one. It is the caller's - /// job not to close the original FieldsReader until all - /// clones are called (eg, currently SegmentReader manages - /// this logic). + /// <see cref="IndexInput"/>s with the original one. It is the caller's + /// job not to dispose the original FieldsReader until all + /// clones are called (eg, currently <see cref="Index.SegmentReader"/> manages + /// this logic). /// </summary> public override object Clone() { @@ -120,7 +121,7 @@ namespace Lucene.Net.Codecs.Lucene40 } } - /// <exception cref="ObjectDisposedException"> if this FieldsReader is closed </exception> + /// <exception cref="ObjectDisposedException"> if this FieldsReader is disposed. </exception> private void EnsureOpen() { if (closed) @@ -130,10 +131,10 @@ namespace Lucene.Net.Codecs.Lucene40 } /// <summary> - /// Closes the underlying <seealso cref="Lucene.Net.Store.IndexInput"/> streams. - /// this means that the Fields values will not be accessible. + /// Closes the underlying <see cref="Lucene.Net.Store.IndexInput"/> streams. + /// This means that the <see cref="Index.Fields"/> values will not be accessible. /// </summary> - /// <exception cref="IOException"> If an I/O error occurs </exception> + /// <exception cref="System.IO.IOException"> If an I/O error occurs. </exception> protected override void Dispose(bool disposing) { if (disposing) @@ -148,6 +149,7 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Returns number of documents. + /// <para/> /// NOTE: This was size() in Lucene. /// </summary> public int Count @@ -265,9 +267,9 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Returns the length in bytes of each raw document in a - /// contiguous range of length numDocs starting with - /// startDocID. Returns the IndexInput (the fieldStream), - /// already seeked to the starting point for startDocID. + /// contiguous range of length <paramref name="numDocs"/> starting with + /// <paramref name="startDocID"/>. Returns the <see cref="IndexInput"/> (the fieldStream), + /// already seeked to the starting point for <paramref name="startDocID"/>. /// </summary> public IndexInput RawDocs(int[] lengths, int startDocID, int numDocs) { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsWriter.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsWriter.cs index b33e43f..77eeced 100644 --- a/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsWriter.cs +++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40StoredFieldsWriter.cs @@ -39,11 +39,12 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Class responsible for writing stored document fields. - /// <p/> + /// <para/> /// It uses <segment>.fdt and <segment>.fdx; files. + /// <para/> + /// @lucene.experimental /// </summary> - /// <seealso cref= Lucene40StoredFieldsFormat - /// @lucene.experimental </seealso> + /// <seealso cref="Lucene40StoredFieldsFormat"/> public sealed class Lucene40StoredFieldsWriter : StoredFieldsWriter { // NOTE: bit 0 is free here! You can steal it! @@ -71,11 +72,11 @@ namespace Lucene.Net.Codecs.Lucene40 internal static readonly long HEADER_LENGTH_DAT = CodecUtil.HeaderLength(CODEC_NAME_DAT); /// <summary> - /// Extension of stored fields file </summary> + /// Extension of stored fields file. </summary> public const string FIELDS_EXTENSION = "fdt"; /// <summary> - /// Extension of stored fields index file </summary> + /// Extension of stored fields index file. </summary> public const string FIELDS_INDEX_EXTENSION = "fdx"; private readonly Directory directory; @@ -242,10 +243,10 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Bulk write a contiguous series of documents. The - /// lengths array is the length (in bytes) of each raw - /// document. The stream IndexInput is the - /// fieldsStream from which we should bulk-copy all - /// bytes. + /// <paramref name="lengths"/> array is the length (in bytes) of each raw + /// document. The <paramref name="stream"/> <see cref="IndexInput"/> is the + /// fieldsStream from which we should bulk-copy all + /// bytes. /// </summary> public void AddRawDocuments(IndexInput stream, int[] lengths, int numDocs) { @@ -309,7 +310,7 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Maximum number of contiguous documents to bulk-copy - /// when merging stored fields + /// when merging stored fields. /// </summary> private const int MAX_RAW_MERGE_DOCS = 4192; http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsFormat.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsFormat.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsFormat.cs index ce91826..269e0f0 100644 --- a/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsFormat.cs +++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsFormat.cs @@ -17,7 +17,6 @@ namespace Lucene.Net.Codecs.Lucene40 * limitations under the License. */ - // javadocs using Directory = Lucene.Net.Store.Directory; using FieldInfos = Lucene.Net.Index.FieldInfos; using IOContext = Lucene.Net.Store.IOContext; @@ -25,87 +24,87 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Lucene 4.0 Term Vectors format. - /// <p>Term Vector support is an optional on a field by field basis. It consists of - /// 3 files.</p> - /// <ol> - /// <li><a name="tvx" id="tvx"></a> - /// <p>The Document Index or .tvx file.</p> - /// <p>For each document, this stores the offset into the document data (.tvd) and - /// field data (.tvf) files.</p> - /// <p>DocumentIndex (.tvx) --> Header,<DocumentPosition,FieldPosition> - /// <sup>NumDocs</sup></p> - /// <ul> - /// <li>Header --> <seealso cref="CodecUtil#writeHeader CodecHeader"/></li> - /// <li>DocumentPosition --> <seealso cref="DataOutput#writeLong UInt64"/> (offset in the .tvd file)</li> - /// <li>FieldPosition --> <seealso cref="DataOutput#writeLong UInt64"/> (offset in the .tvf file)</li> - /// </ul> - /// </li> - /// <li><a name="tvd" id="tvd"></a> - /// <p>The Document or .tvd file.</p> - /// <p>this contains, for each document, the number of fields, a list of the fields + /// <para>Term Vector support is an optional on a field by field basis. It consists of + /// 3 files.</para> + /// <list type="number"> + /// <item><description><a name="tvx" id="tvx"></a> + /// <para>The Document Index or .tvx file.</para> + /// <para>For each document, this stores the offset into the document data (.tvd) and + /// field data (.tvf) files.</para> + /// <para>DocumentIndex (.tvx) --> Header,<DocumentPosition,FieldPosition> + /// <sup>NumDocs</sup></para> + /// <list type="bullet"> + /// <item><description>Header --> CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item> + /// <item><description>DocumentPosition --> UInt64 (<see cref="Store.DataOutput.WriteInt64(long)"/>) (offset in the .tvd file)</description></item> + /// <item><description>FieldPosition --> UInt64 (<see cref="Store.DataOutput.WriteInt64(long)"/>) (offset in the .tvf file)</description></item> + /// </list> + /// </description></item> + /// <item><description><a name="tvd" id="tvd"></a> + /// <para>The Document or .tvd file.</para> + /// <para>This contains, for each document, the number of fields, a list of the fields /// with term vector info and finally a list of pointers to the field information - /// in the .tvf (Term Vector Fields) file.</p> - /// <p>The .tvd file is used to map out the fields that have term vectors stored - /// and where the field information is in the .tvf file.</p> - /// <p>Document (.tvd) --> Header,<NumFields, FieldNums, - /// FieldPositions> <sup>NumDocs</sup></p> - /// <ul> - /// <li>Header --> <seealso cref="CodecUtil#writeHeader CodecHeader"/></li> - /// <li>NumFields --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>FieldNums --> <FieldNumDelta> <sup>NumFields</sup></li> - /// <li>FieldNumDelta --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>FieldPositions --> <FieldPositionDelta> <sup>NumFields-1</sup></li> - /// <li>FieldPositionDelta --> <seealso cref="DataOutput#writeVLong VLong"/></li> - /// </ul> - /// </li> - /// <li><a name="tvf" id="tvf"></a> - /// <p>The Field or .tvf file.</p> - /// <p>this file contains, for each field that has a term vector stored, a list of + /// in the .tvf (Term Vector Fields) file.</para> + /// <para>The .tvd file is used to map out the fields that have term vectors stored + /// and where the field information is in the .tvf file.</para> + /// <para>Document (.tvd) --> Header,<NumFields, FieldNums, + /// FieldPositions> <sup>NumDocs</sup></para> + /// <list type="bullet"> + /// <item><description>Header --> CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item> + /// <item><description>NumFields --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>FieldNums --> <FieldNumDelta> <sup>NumFields</sup></description></item> + /// <item><description>FieldNumDelta --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>FieldPositions --> <FieldPositionDelta> <sup>NumFields-1</sup></description></item> + /// <item><description>FieldPositionDelta --> VLong (<see cref="Store.DataOutput.WriteVInt64(long)"/>) </description></item> + /// </list> + /// </description></item> + /// <item><description><a name="tvf" id="tvf"></a> + /// <para>The Field or .tvf file.</para> + /// <para>This file contains, for each field that has a term vector stored, a list of /// the terms, their frequencies and, optionally, position, offset, and payload - /// information.</p> - /// <p>Field (.tvf) --> Header,<NumTerms, Flags, TermFreqs> - /// <sup>NumFields</sup></p> - /// <ul> - /// <li>Header --> <seealso cref="CodecUtil#writeHeader CodecHeader"/></li> - /// <li>NumTerms --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>Flags --> <seealso cref="DataOutput#writeByte Byte"/></li> - /// <li>TermFreqs --> <TermText, TermFreq, Positions?, PayloadData?, Offsets?> - /// <sup>NumTerms</sup></li> - /// <li>TermText --> <PrefixLength, Suffix></li> - /// <li>PrefixLength --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>Suffix --> <seealso cref="DataOutput#writeString String"/></li> - /// <li>TermFreq --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>Positions --> <PositionDelta PayloadLength?><sup>TermFreq</sup></li> - /// <li>PositionDelta --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>PayloadLength --> <seealso cref="DataOutput#writeVInt VInt"/></li> - /// <li>PayloadData --> <seealso cref="DataOutput#writeByte Byte"/><sup>NumPayloadBytes</sup></li> - /// <li>Offsets --> <<seealso cref="DataOutput#writeVInt VInt"/>, <seealso cref="DataOutput#writeVInt VInt"/>><sup>TermFreq</sup></li> - /// </ul> - /// <p>Notes:</p> - /// <ul> - /// <li>Flags byte stores whether this term vector has position, offset, payload. - /// information stored.</li> - /// <li>Term byte prefixes are shared. The PrefixLength is the number of initial + /// information.</para> + /// <para>Field (.tvf) --> Header,<NumTerms, Flags, TermFreqs> + /// <sup>NumFields</sup></para> + /// <list type="bullet"> + /// <item><description>Header --> CodecHeader (<see cref="CodecUtil.WriteHeader(Store.DataOutput, string, int)"/>) </description></item> + /// <item><description>NumTerms --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>Flags --> Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) </description></item> + /// <item><description>TermFreqs --> <TermText, TermFreq, Positions?, PayloadData?, Offsets?> + /// <sup>NumTerms</sup></description></item> + /// <item><description>TermText --> <PrefixLength, Suffix></description></item> + /// <item><description>PrefixLength --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>Suffix --> String (<see cref="Store.DataOutput.WriteString(string)"/>) </description></item> + /// <item><description>TermFreq --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>Positions --> <PositionDelta PayloadLength?><sup>TermFreq</sup></description></item> + /// <item><description>PositionDelta --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>PayloadLength --> VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) </description></item> + /// <item><description>PayloadData --> Byte (<see cref="Store.DataOutput.WriteByte(byte)"/>) <sup>NumPayloadBytes</sup></description></item> + /// <item><description>Offsets --> <VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>), VInt (<see cref="Store.DataOutput.WriteVInt32(int)"/>) ><sup>TermFreq</sup></description></item> + /// </list> + /// <para>Notes:</para> + /// <list type="bullet"> + /// <item><description>Flags byte stores whether this term vector has position, offset, payload. + /// information stored.</description></item> + /// <item><description>Term byte prefixes are shared. The PrefixLength is the number of initial /// bytes from the previous term which must be pre-pended to a term's suffix /// in order to form the term's bytes. Thus, if the previous term's text was "bone" - /// and the term is "boy", the PrefixLength is two and the suffix is "y".</li> - /// <li>PositionDelta is, if payloads are disabled for the term's field, the + /// and the term is "boy", the PrefixLength is two and the suffix is "y".</description></item> + /// <item><description>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.</li> - /// <li>PayloadData is metadata associated with a term position. If + /// the length of the payload at the current term position.</description></item> + /// <item><description>PayloadData is metadata associated with a 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. PayloadData encodes the - /// concatenated bytes for all of a terms occurrences.</li> - /// <li>Offsets are stored as delta encoded VInts. The first VInt is the - /// startOffset, the second is the endOffset.</li> - /// </ul> - /// </li> - /// </ol> + /// concatenated bytes for all of a terms occurrences.</description></item> + /// <item><description>Offsets are stored as delta encoded VInts. The first VInt is the + /// startOffset, the second is the endOffset.</description></item> + /// </list> + /// </description></item> + /// </list> /// </summary> public class Lucene40TermVectorsFormat : TermVectorsFormat { http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsReader.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsReader.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsReader.cs index a0de655..0d44dec 100644 --- a/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsReader.cs +++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsReader.cs @@ -41,10 +41,10 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Lucene 4.0 Term Vectors reader. - /// <p> + /// <para/> /// It reads .tvd, .tvf, and .tvx files. /// </summary> - /// <seealso cref= Lucene40TermVectorsFormat </seealso> + /// <seealso cref="Lucene40TermVectorsFormat"/> public class Lucene40TermVectorsReader : TermVectorsReader, IDisposable { internal const sbyte STORE_POSITIONS_WITH_TERMVECTOR = 0x1; @@ -54,15 +54,15 @@ namespace Lucene.Net.Codecs.Lucene40 internal const sbyte STORE_PAYLOAD_WITH_TERMVECTOR = 0x4; /// <summary> - /// Extension of vectors fields file </summary> + /// Extension of vectors fields file. </summary> internal const string VECTORS_FIELDS_EXTENSION = "tvf"; /// <summary> - /// Extension of vectors documents file </summary> + /// Extension of vectors documents file. </summary> internal const string VECTORS_DOCUMENTS_EXTENSION = "tvd"; /// <summary> - /// Extension of vectors index file </summary> + /// Extension of vectors index file. </summary> internal const string VECTORS_INDEX_EXTENSION = "tvx"; internal const string CODEC_NAME_FIELDS = "Lucene40TermVectorsFields"; @@ -181,11 +181,11 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Retrieve the length (in bytes) of the tvd and tvf - /// entries for the next numDocs starting with - /// startDocID. this is used for bulk copying when - /// merging segments, if the field numbers are - /// congruent. Once this returns, the tvf & tvd streams - /// are seeked to the startDocID. + /// entries for the next <paramref name="numDocs"/> starting with + /// <paramref name="startDocID"/>. This is used for bulk copying when + /// merging segments, if the field numbers are + /// congruent. Once this returns, the tvf & tvd streams + /// are seeked to the <paramref name="startDocID"/>. /// </summary> internal void RawDocs(int[] tvdLengths, int[] tvfLengths, int startDocID, int numDocs) { @@ -238,7 +238,8 @@ namespace Lucene.Net.Codecs.Lucene40 } /// <summary> - /// The number of documents in the reader + /// The number of documents in the reader. + /// <para/> /// NOTE: This was size() in Lucene. /// </summary> internal virtual int Count http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27cdd048/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsWriter.cs ---------------------------------------------------------------------- diff --git a/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsWriter.cs b/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsWriter.cs index 41bc759..5a8063e 100644 --- a/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsWriter.cs +++ b/src/Lucene.Net/Codecs/Lucene40/Lucene40TermVectorsWriter.cs @@ -50,10 +50,10 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Lucene 4.0 Term Vectors writer. - /// <p> + /// <para/> /// It writes .tvd, .tvf, and .tvx files. /// </summary> - /// <seealso cref= Lucene40TermVectorsFormat </seealso> + /// <seealso cref="Lucene40TermVectorsFormat"/> public sealed class Lucene40TermVectorsWriter : TermVectorsWriter { private readonly Directory directory; @@ -335,7 +335,7 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Do a bulk copy of numDocs documents from reader to our - /// streams. this is used to expedite merging, if the + /// streams. This is used to expedite merging, if the /// field numbers are congruent. /// </summary> private void AddRawDocuments(Lucene40TermVectorsReader reader, int[] tvdLengths, int[] tvfLengths, int numDocs) @@ -395,7 +395,7 @@ namespace Lucene.Net.Codecs.Lucene40 /// <summary> /// Maximum number of contiguous documents to bulk-copy - /// when merging term vectors + /// when merging term vectors. /// </summary> private const int MAX_RAW_MERGE_DOCS = 4192;
