You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by ni...@apache.org on 2017/06/06 00:12:15 UTC
[42/48] lucenenet git commit: Lucene.Net.Codecs.Lucene3x: Fixed XML
documentation comment warnings
Lucene.Net.Codecs.Lucene3x: 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/95b5d4bb
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/95b5d4bb
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/95b5d4bb
Branch: refs/heads/master
Commit: 95b5d4bba0f1ce86aa65076885f168716dea851c
Parents: 27cdd04
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Mon Jun 5 14:38:17 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Tue Jun 6 06:58:41 2017 +0700
----------------------------------------------------------------------
CONTRIBUTING.md | 3 +-
src/Lucene.Net/Codecs/Lucene3x/Lucene3xCodec.cs | 5 +-
.../Codecs/Lucene3x/Lucene3xFieldInfosFormat.cs | 6 +--
.../Codecs/Lucene3x/Lucene3xFieldInfosReader.cs | 3 +-
.../Codecs/Lucene3x/Lucene3xFields.cs | 5 +-
.../Codecs/Lucene3x/Lucene3xNormsFormat.cs | 6 +--
.../Codecs/Lucene3x/Lucene3xNormsProducer.cs | 13 +++---
.../Codecs/Lucene3x/Lucene3xPostingsFormat.cs | 17 ++++---
.../Lucene3x/Lucene3xSegmentInfoFormat.cs | 24 +++++-----
.../Lucene3x/Lucene3xSegmentInfoReader.cs | 9 ++--
.../Codecs/Lucene3x/Lucene3xSkipListReader.cs | 10 ++--
.../Lucene3x/Lucene3xStoredFieldsFormat.cs | 1 -
.../Lucene3x/Lucene3xStoredFieldsReader.cs | 23 +++++----
.../Lucene3x/Lucene3xTermVectorsFormat.cs | 6 +--
.../Lucene3x/Lucene3xTermVectorsReader.cs | 13 ++++--
.../Codecs/Lucene3x/SegmentTermDocs.cs | 7 +--
.../Codecs/Lucene3x/SegmentTermEnum.cs | 35 +++++++-------
.../Codecs/Lucene3x/SegmentTermPositions.cs | 6 +--
src/Lucene.Net/Codecs/Lucene3x/TermBuffer.cs | 4 +-
src/Lucene.Net/Codecs/Lucene3x/TermInfo.cs | 9 ++--
.../Codecs/Lucene3x/TermInfosReader.cs | 25 +++++-----
.../Codecs/Lucene3x/TermInfosReaderIndex.cs | 49 ++++++++++----------
22 files changed, 138 insertions(+), 141 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c8a36fb..5c39dc4 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -52,8 +52,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. Util.Packed (namespace)
+ 2. Util.Packed (namespace)
2. Lucene.Net.Codecs (project)
1. Appending (namespace)
2. BlockTerms (namespace)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xCodec.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xCodec.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xCodec.cs
index f3ae770..773958b 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xCodec.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xCodec.cs
@@ -28,7 +28,6 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <summary>
/// Supports the Lucene 3.x index format (readonly) </summary>
- /// @deprecated Only for reading existing 3.x indexes
[Obsolete("Only for reading existing 3.x indexes")]
[CodecName("Lucene3x")] // LUCENENET specific - using CodecName attribute to ensure the default name passed from subclasses is the same as this class name
public class Lucene3xCodec : Codec
@@ -51,7 +50,7 @@ namespace Lucene.Net.Codecs.Lucene3x
private readonly Lucene3xNormsFormat normsFormat = new Lucene3xNormsFormat();
/// <summary>
- /// Extension of compound file for doc store files </summary>
+ /// Extension of compound file for doc store files. </summary>
internal const string COMPOUND_FILE_STORE_EXTENSION = "cfx";
// TODO: this should really be a different impl
@@ -120,7 +119,7 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <summary>
/// Returns file names for shared doc stores, if any, else
- /// null.
+ /// <c>null</c>.
/// </summary>
public static ISet<string> GetDocStoreFiles(SegmentInfo info)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosFormat.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosFormat.cs
index 329369f..5ab5488 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosFormat.cs
@@ -20,10 +20,10 @@ namespace Lucene.Net.Codecs.Lucene3x
*/
/// <summary>
- /// Lucene3x ReadOnly FieldInfosFromat implementation </summary>
- /// @deprecated (4.0) this is only used to read indexes created
- /// before 4.0.
+ /// Lucene3x ReadOnly <see cref="FieldInfosFormat"/> implementation.
+ /// <para/>
/// @lucene.experimental
+ /// </summary>
[Obsolete("(4.0) this is only used to read indexes created before 4.0")]
internal class Lucene3xFieldInfosFormat : FieldInfosFormat
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosReader.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosReader.cs
index 8377418..3e3d0ac 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFieldInfosReader.cs
@@ -35,12 +35,11 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <summary>
/// @lucene.experimental </summary>
- /// @deprecated Only for reading existing 3.x indexes
[Obsolete("Only for reading existing 3.x indexes")]
internal class Lucene3xFieldInfosReader : FieldInfosReader
{
/// <summary>
- /// Extension of field infos </summary>
+ /// Extension of field infos. </summary>
internal const string FIELD_INFOS_EXTENSION = "fnm";
// First used in 2.9; prior to 2.9 there was no format header
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFields.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFields.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFields.cs
index e34ddbe..81aae0d 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFields.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xFields.cs
@@ -43,8 +43,9 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <summary>
/// Exposes flex API on a pre-flex index, as a codec.
- /// @lucene.experimental </summary>
- /// @deprecated (4.0)
+ /// <para/>
+ /// @lucene.experimental
+ /// </summary>
[Obsolete("(4.0)")]
internal class Lucene3xFields : FieldsProducer
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsFormat.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsFormat.cs
index 21b2cbd..356cd8b 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsFormat.cs
@@ -23,10 +23,10 @@ namespace Lucene.Net.Codecs.Lucene3x
using SegmentWriteState = Lucene.Net.Index.SegmentWriteState;
/// <summary>
- /// Lucene3x ReadOnly NormsFormat implementation </summary>
- /// @deprecated (4.0) this is only used to read indexes created
- /// before 4.0.
+ /// Lucene3x ReadOnly <see cref="NormsFormat"/> implementation.
+ /// <para/>
/// @lucene.experimental
+ /// </summary>
[Obsolete("(4.0) this is only used to read indexes created before 4.0.")]
internal class Lucene3xNormsFormat : NormsFormat
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsProducer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsProducer.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsProducer.cs
index 00faced..ed32a6f 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsProducer.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xNormsProducer.cs
@@ -41,22 +41,23 @@ namespace Lucene.Net.Codecs.Lucene3x
using StringHelper = Lucene.Net.Util.StringHelper;
/// <summary>
- /// Reads Lucene 3.x norms format and exposes it via DocValues API
- /// @lucene.experimental </summary>
- /// @deprecated Only for reading existing 3.x indexes
+ /// Reads Lucene 3.x norms format and exposes it via <see cref="Index.DocValues"/> API.
+ /// <para/>
+ /// @lucene.experimental
+ /// </summary>
[Obsolete("Only for reading existing 3.x indexes")]
internal class Lucene3xNormsProducer : DocValuesProducer
{
/// <summary>
- /// norms header placeholder </summary>
+ /// Norms header placeholder. </summary>
internal static readonly sbyte[] NORMS_HEADER = { (sbyte)'N', (sbyte)'R', (sbyte)'M', -1 };
/// <summary>
- /// Extension of norms file </summary>
+ /// Extension of norms file. </summary>
internal const string NORMS_EXTENSION = "nrm";
/// <summary>
- /// Extension of separate norms file </summary>
+ /// Extension of separate norms file. </summary>
internal const string SEPARATE_NORMS_EXTENSION = "s";
private readonly IDictionary<string, NormsDocValues> norms = new Dictionary<string, NormsDocValues>();
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xPostingsFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xPostingsFormat.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xPostingsFormat.cs
index c5e4c1b..0d368ff 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xPostingsFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xPostingsFormat.cs
@@ -23,26 +23,25 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <summary>
/// Codec that reads the pre-flex-indexing postings
- /// format. It does not provide a writer because newly
- /// written segments should use the Codec configured on IndexWriter.
- /// </summary>
- /// @deprecated (4.0) this is only used to read indexes created
- /// before 4.0.
+ /// format. It does not provide a writer because newly
+ /// written segments should use the <see cref="Codec"/> configured on <see cref="Index.IndexWriter"/>.
+ /// <para/>
/// @lucene.experimental
- [Obsolete("(4.0) this is only used to read indexes created")]
+ /// </summary>
+ [Obsolete("(4.0) this is only used to read indexes created before 4.0.")]
[PostingsFormatName("Lucene3x")] // LUCENENET specific - using PostingsFormatName attribute to ensure the default name passed from subclasses is the same as this class name
internal class Lucene3xPostingsFormat : PostingsFormat
{
/// <summary>
- /// Extension of terms file </summary>
+ /// Extension of terms file. </summary>
public const string TERMS_EXTENSION = "tis";
/// <summary>
- /// Extension of terms index file </summary>
+ /// Extension of terms index file. </summary>
public const string TERMS_INDEX_EXTENSION = "tii";
/// <summary>
- /// Extension of freq postings file </summary>
+ /// Extension of freq postings file. </summary>
public const string FREQ_EXTENSION = "frq";
/// <summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoFormat.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoFormat.cs
index 86c55de..da18377 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoFormat.cs
@@ -23,23 +23,23 @@ namespace Lucene.Net.Codecs.Lucene3x
using SegmentInfo = Lucene.Net.Index.SegmentInfo;
/// <summary>
- /// Lucene3x ReadOnly SegmentInfoFormat implementation </summary>
- /// @deprecated (4.0) this is only used to read indexes created
- /// before 4.0.
+ /// Lucene3x ReadOnly <see cref="SegmentInfoFormat"/> implementation.
+ /// <para/>
/// @lucene.experimental
- [Obsolete("(4.0) this is only used to read indexes created")]
+ /// </summary>
+ [Obsolete("(4.0) this is only used to read indexes created before 4.0.")]
public class Lucene3xSegmentInfoFormat : SegmentInfoFormat
{
private readonly SegmentInfoReader reader = new Lucene3xSegmentInfoReader();
/// <summary>
- /// this format adds optional per-segment String
- /// diagnostics storage, and switches userData to Map
+ /// This format adds optional per-segment String
+ /// diagnostics storage, and switches userData to Map.
/// </summary>
public static readonly int FORMAT_DIAGNOSTICS = -9;
/// <summary>
- /// Each segment records whether it has term vectors </summary>
+ /// Each segment records whether it has term vectors. </summary>
public static readonly int FORMAT_HAS_VECTORS = -10;
/// <summary>
@@ -48,7 +48,7 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <summary>
/// Extension used for saving each SegmentInfo, once a 3.x
- /// index is first committed to with 4.0.
+ /// index is first committed to with 4.0.
/// </summary>
public static readonly string UPGRADED_SI_EXTENSION = "si";
@@ -80,22 +80,22 @@ namespace Lucene.Net.Codecs.Lucene3x
public static readonly string NORMGEN_KEY = typeof(Lucene3xSegmentInfoFormat).Name + ".normgen";
public static readonly string NORMGEN_PREFIX = typeof(Lucene3xSegmentInfoFormat).Name + ".normfield";
- /// <returns> if this segment shares stored fields & vectors, this
- /// offset is where in that file this segment's docs begin </returns>
+ /// <returns> If this segment shares stored fields & vectors, this
+ /// offset is where in that file this segment's docs begin. </returns>
public static int GetDocStoreOffset(SegmentInfo si)
{
string v = si.GetAttribute(DS_OFFSET_KEY);
return v == null ? -1 : Convert.ToInt32(v, CultureInfo.InvariantCulture);
}
- /// <returns> name used to derive fields/vectors file we share with other segments </returns>
+ /// <returns> Name used to derive fields/vectors file we share with other segments. </returns>
public static string GetDocStoreSegment(SegmentInfo si)
{
string v = si.GetAttribute(DS_NAME_KEY);
return v == null ? si.Name : v;
}
- /// <returns> whether doc store files are stored in compound file (*.cfx) </returns>
+ /// <returns> Whether doc store files are stored in compound file (*.cfx). </returns>
public static bool GetDocStoreIsCompoundFile(SegmentInfo si)
{
string v = si.GetAttribute(DS_COMPOUND_KEY);
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoReader.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoReader.cs
index da6a314..2e4b015 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSegmentInfoReader.cs
@@ -36,9 +36,10 @@ namespace Lucene.Net.Codecs.Lucene3x
using SegmentInfos = Lucene.Net.Index.SegmentInfos;
/// <summary>
- /// Lucene 3x implementation of <seealso cref="SegmentInfoReader"/>.
- /// @lucene.experimental </summary>
- /// @deprecated Only for reading existing 3.x indexes
+ /// Lucene 3x implementation of <see cref="SegmentInfoReader"/>.
+ /// <para/>
+ /// @lucene.experimental
+ /// </summary>
[Obsolete("Only for reading existing 3.x indexes")]
public class Lucene3xSegmentInfoReader : SegmentInfoReader
{
@@ -138,7 +139,7 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// reads from legacy 3.x segments_N </summary>
+ /// Reads from legacy 3.x segments_N. </summary>
private SegmentCommitInfo ReadLegacySegmentInfo(Directory dir, int format, IndexInput input)
{
// check that it is a format we can understand
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSkipListReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSkipListReader.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSkipListReader.cs
index baa16b3..05f64e8 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSkipListReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xSkipListReader.cs
@@ -22,9 +22,7 @@ namespace Lucene.Net.Codecs.Lucene3x
using IndexInput = Lucene.Net.Store.IndexInput;
- /// @deprecated (4.0) this is only used to read indexes created
- /// before 4.0.
- [Obsolete("(4.0) this is only used to read indexes created")]
+ [Obsolete("(4.0) this is only used to read indexes created before 4.0.")]
internal sealed class Lucene3xSkipListReader : MultiLevelSkipListReader
{
private bool currentFieldStoresPayloads;
@@ -58,7 +56,7 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <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 long FreqPointer
{
@@ -70,7 +68,7 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <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 long ProxPointer
{
@@ -82,7 +80,7 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <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 int PayloadLength
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsFormat.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsFormat.cs
index 051dc79..af10590 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsFormat.cs
@@ -24,7 +24,6 @@ namespace Lucene.Net.Codecs.Lucene3x
using IOContext = Lucene.Net.Store.IOContext;
using SegmentInfo = Lucene.Net.Index.SegmentInfo;
- /// @deprecated Only for reading existing 3.x indexes
[Obsolete("Only for reading existing 3.x indexes")]
internal class Lucene3xStoredFieldsFormat : StoredFieldsFormat
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsReader.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsReader.cs
index d30d7a2..8e019f2 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xStoredFieldsReader.cs
@@ -38,21 +38,20 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <summary>
/// Class responsible for access to stored document fields.
- /// <p/>
+ /// <para/>
/// It uses <segment>.fdt and <segment>.fdx; files.
/// </summary>
- /// @deprecated Only for reading existing 3.x indexes
[Obsolete("Only for reading existing 3.x indexes")]
internal sealed class Lucene3xStoredFieldsReader : StoredFieldsReader, IDisposable
{
private const int FORMAT_SIZE = 4;
/// <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";
// Lucene 3.0: Removal of compressed fields
@@ -100,10 +99,10 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <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).
+ /// 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).
/// </summary>
public override object Clone()
{
@@ -228,7 +227,7 @@ namespace Lucene.Net.Codecs.Lucene3x
}
}
- /// <exception cref="ObjectDisposedException"> if this FieldsReader is closed </exception>
+ /// <exception cref="ObjectDisposedException"> If this FieldsReader is disposed. </exception>
private void EnsureOpen()
{
if (closed)
@@ -238,10 +237,10 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <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 Fields values will not be accessible.
/// </summary>
- /// <exception cref="IOException"> If there is a low-level I/O error. </exception>
+ /// <exception cref="System.IO.IOException"> If there is a low-level I/O error. </exception>
protected override void Dispose(bool disposing)
{
if (disposing)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsFormat.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsFormat.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsFormat.cs
index c222b97..8e1bdd7 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsFormat.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsFormat.cs
@@ -27,10 +27,10 @@ namespace Lucene.Net.Codecs.Lucene3x
using SegmentInfo = Lucene.Net.Index.SegmentInfo;
/// <summary>
- /// Lucene3x ReadOnly TermVectorsFormat implementation </summary>
- /// @deprecated (4.0) this is only used to read indexes created
- /// before 4.0.
+ /// Lucene3x ReadOnly <see cref="TermVectorsFormat"/> implementation
+ /// <para/>
/// @lucene.experimental
+ /// </summary>
[Obsolete("(4.0) this is only used to read indexes created before 4.0.")]
internal class Lucene3xTermVectorsFormat : TermVectorsFormat
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsReader.cs b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsReader.cs
index dbce339..7fbdf32 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/Lucene3xTermVectorsReader.cs
@@ -42,7 +42,6 @@ namespace Lucene.Net.Codecs.Lucene3x
using Terms = Lucene.Net.Index.Terms;
using TermsEnum = Lucene.Net.Index.TermsEnum;
- /// @deprecated Only for reading existing 3.x indexes
[Obsolete("Only for reading existing 3.x indexes")]
internal class Lucene3xTermVectorsReader : TermVectorsReader
{
@@ -67,15 +66,15 @@ namespace Lucene.Net.Codecs.Lucene3x
public const sbyte STORE_OFFSET_WITH_TERMVECTOR = 0x2;
/// <summary>
- /// Extension of vectors fields file </summary>
+ /// Extension of vectors fields file. </summary>
public const string VECTORS_FIELDS_EXTENSION = "tvf";
/// <summary>
- /// Extension of vectors documents file </summary>
+ /// Extension of vectors documents file. </summary>
public const string VECTORS_DOCUMENTS_EXTENSION = "tvd";
/// <summary>
- /// Extension of vectors index file </summary>
+ /// Extension of vectors index file. </summary>
public const string VECTORS_INDEX_EXTENSION = "tvx";
private readonly FieldInfos fieldInfos;
@@ -211,7 +210,11 @@ namespace Lucene.Net.Codecs.Lucene3x
}
}
- /// <summary>The number of documents in the reader. NOTE: This was size() in Lucene.</summary>
+ /// <summary>
+ /// The number of documents in the reader.
+ /// <para/>
+ /// NOTE: This was size() in Lucene.
+ /// </summary>
internal virtual int Count
{
get { return size; }
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/SegmentTermDocs.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/SegmentTermDocs.cs b/src/Lucene.Net/Codecs/Lucene3x/SegmentTermDocs.cs
index 9c0b3eb..ad4ae16 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/SegmentTermDocs.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/SegmentTermDocs.cs
@@ -27,8 +27,9 @@ namespace Lucene.Net.Codecs.Lucene3x
using IndexOptions = Lucene.Net.Index.IndexOptions;
using Term = Lucene.Net.Index.Term;
- /// @deprecated (4.0)
- /// @lucene.experimental
+ /// <summary>
+ /// @lucene.experimental
+ /// </summary>
[Obsolete("(4.0)")]
internal class SegmentTermDocs
{
@@ -256,7 +257,7 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// Overridden by SegmentTermPositions to skip in prox stream. </summary>
+ /// Overridden by <see cref="SegmentTermPositions"/> to skip in prox stream. </summary>
protected internal virtual void SkipProx(long proxPointer, int payloadLength)
{
}
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/SegmentTermEnum.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/SegmentTermEnum.cs b/src/Lucene.Net/Codecs/Lucene3x/SegmentTermEnum.cs
index 68d5a73..7782028 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/SegmentTermEnum.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/SegmentTermEnum.cs
@@ -26,10 +26,9 @@ namespace Lucene.Net.Codecs.Lucene3x
using IndexInput = Lucene.Net.Store.IndexInput;
using Term = Lucene.Net.Index.Term;
- /// @deprecated (4.0) No longer used with flex indexing, except for
- /// reading old segments
+ /// <summary>
/// @lucene.experimental
-
+ /// </summary>
[Obsolete("(4.0) No longer used with flex indexing, except for reading old segments")]
internal sealed class SegmentTermEnum : IDisposable
{
@@ -204,7 +203,7 @@ namespace Lucene.Net.Codecs.Lucene3x
/// <summary>
/// Returns the current Term in the enumeration.
- /// Initially invalid, valid after next() called for the first time.
+ /// Initially invalid, valid after <see cref="Next()"/> called for the first time.
/// </summary>
public Term Term()
{
@@ -212,15 +211,15 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// Returns the previous Term enumerated. Initially null. </summary>
+ /// Returns the previous Term enumerated. Initially <c>null</c>. </summary>
internal Term Prev()
{
return prevBuffer.ToTerm();
}
/// <summary>
- /// Returns the current TermInfo in the enumeration.
- /// Initially invalid, valid after next() called for the first time.
+ /// Returns the current <see cref="Lucene3x.TermInfo"/> in the enumeration.
+ /// Initially invalid, valid after <see cref="Next()"/> called for the first time.
/// </summary>
internal TermInfo TermInfo()
{
@@ -228,8 +227,8 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// Sets the argument to the current TermInfo in the enumeration.
- /// Initially invalid, valid after next() called for the first time.
+ /// Sets the argument to the current <see cref="Lucene3x.TermInfo"/> in the enumeration.
+ /// Initially invalid, valid after <see cref="Next()"/> called for the first time.
/// </summary>
internal void TermInfo(TermInfo ti)
{
@@ -237,25 +236,27 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// Returns the docFreq from the current TermInfo in the enumeration.
- /// Initially invalid, valid after next() called for the first time.
+ /// Returns the docFreq from the current <see cref="Lucene3x.TermInfo"/> in the enumeration.
+ /// Initially invalid, valid after <see cref="Next()"/> called for the first time.
/// </summary>
public int DocFreq
{
get { return termInfo.DocFreq; }
}
- /* Returns the freqPointer from the current TermInfo in the enumeration.
- Initially invalid, valid after next() called for the first time.*/
-
+ /// <summary>
+ /// Returns the freqPointer from the current <see cref="Lucene3x.TermInfo"/> in the enumeration.
+ /// Initially invalid, valid after<see cref="Next()"/> called for the first time.
+ /// </summary>
internal long FreqPointer
{
get { return termInfo.FreqPointer; }
}
- /* Returns the proxPointer from the current TermInfo in the enumeration.
- Initially invalid, valid after next() called for the first time.*/
-
+ /// <summary>
+ /// Returns the proxPointer from the current <see cref="Lucene3x.TermInfo"/> in the enumeration.
+ /// Initially invalid, valid after<see cref="Next()"/> called for the first time.
+ /// </summary>
internal long ProxPointer
{
get { return termInfo.ProxPointer; }
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/SegmentTermPositions.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/SegmentTermPositions.cs b/src/Lucene.Net/Codecs/Lucene3x/SegmentTermPositions.cs
index 8a8c762..beaf93d 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/SegmentTermPositions.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/SegmentTermPositions.cs
@@ -27,8 +27,8 @@ namespace Lucene.Net.Codecs.Lucene3x
using Term = Lucene.Net.Index.Term;
/// <summary>
- /// @lucene.experimental </summary>
- /// @deprecated (4.0)
+ /// @lucene.experimental
+ /// </summary>
[Obsolete("(4.0)")]
internal sealed class SegmentTermPositions : SegmentTermDocs
{
@@ -155,7 +155,7 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// Called by super.skipTo(). </summary>
+ /// Called by <c>base.SkipTo()</c>. </summary>
protected internal override void SkipProx(long proxPointer, int payloadLength)
{
// we save the pointer, we might have to skip there lazily
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/TermBuffer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/TermBuffer.cs b/src/Lucene.Net/Codecs/Lucene3x/TermBuffer.cs
index d414e67..1c457dc 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/TermBuffer.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/TermBuffer.cs
@@ -29,8 +29,8 @@ namespace Lucene.Net.Codecs.Lucene3x
using Term = Lucene.Net.Index.Term;
/// <summary>
- /// @lucene.experimental </summary>
- /// @deprecated (4.0)
+ /// @lucene.experimental
+ /// </summary>
[Obsolete("(4.0)")]
internal sealed class TermBuffer
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/TermInfo.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/TermInfo.cs b/src/Lucene.Net/Codecs/Lucene3x/TermInfo.cs
index d4caa08..09f3411 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/TermInfo.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/TermInfo.cs
@@ -20,12 +20,9 @@ namespace Lucene.Net.Codecs.Lucene3x
*/
/// <summary>
- /// A TermInfo is the record of information stored for a
- /// term </summary>
- /// @deprecated (4.0) this class is no longer used in flexible
- /// indexing.
-
- [Obsolete]
+ /// A <see cref="TermInfo"/> is the record of information stored for a
+ /// term. </summary>
+ [Obsolete("(4.0) this class is no longer used in flexible indexing.")]
internal class TermInfo
{
/// <summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/TermInfosReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/TermInfosReader.cs b/src/Lucene.Net/Codecs/Lucene3x/TermInfosReader.cs
index 5af2731..90360e8 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/TermInfosReader.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/TermInfosReader.cs
@@ -32,13 +32,13 @@ namespace Lucene.Net.Codecs.Lucene3x
using Term = Lucene.Net.Index.Term;
/// <summary>
- /// this stores a monotonically increasing set of <Term, TermInfo> pairs in a
- /// Directory. Pairs are accessed either by Term or by ordinal position the
- /// set </summary>
- /// @deprecated (4.0) this class has been replaced by
- /// FormatPostingsTermsDictReader, except for reading old segments.
+ /// This stores a monotonically increasing set of <c>Term, TermInfo</c> pairs in a
+ /// Directory. Pairs are accessed either by <see cref="Term"/> or by ordinal position the
+ /// set.
+ /// <para/>
/// @lucene.experimental
- [Obsolete("(4.0) this class has been replaced by")]
+ /// </summary>
+ [Obsolete("(4.0) this class has been replaced by FormatPostingsTermsDictReader, except for reading old segments.")]
internal sealed class TermInfosReader : IDisposable
{
private readonly Directory directory;
@@ -98,7 +98,7 @@ namespace Lucene.Net.Codecs.Lucene3x
private readonly DoubleBarrelLRUCache<CloneableTerm, TermInfoAndOrd> termsCache = new DoubleBarrelLRUCache<CloneableTerm, TermInfoAndOrd>(DEFAULT_CACHE_SIZE);
/// <summary>
- /// Per-thread resources managed by ThreadLocal
+ /// Per-thread resources managed by ThreadLocal.
/// </summary>
private sealed class ThreadResources
{
@@ -186,7 +186,8 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// Returns the number of term/value pairs in the set.
+ /// Returns the number of term/value pairs in the set.
+ /// <para/>
/// NOTE: This was size() in Lucene.
/// </summary>
internal long Count
@@ -221,14 +222,14 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// Returns the TermInfo for a Term in the set, or null. </summary>
+ /// Returns the <see cref="TermInfo"/> for a <see cref="Term"/> in the set, or <c>null</c>. </summary>
internal TermInfo Get(Term term)
{
return Get(term, false);
}
/// <summary>
- /// Returns the TermInfo for a Term in the set, or null. </summary>
+ /// Returns the <see cref="TermInfo"/> for a <see cref="Term"/> in the set, or <c>null</c>. </summary>
private TermInfo Get(Term term, bool mustSeekEnum)
{
if (size == 0)
@@ -391,7 +392,7 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// Returns the position of a Term in the set or -1. </summary>
+ /// Returns the position of a <see cref="Term"/> in the set or -1. </summary>
internal long GetPosition(Term term)
{
if (size == 0)
@@ -420,7 +421,7 @@ namespace Lucene.Net.Codecs.Lucene3x
}
/// <summary>
- /// Returns an enumeration of all the Terms and TermInfos in the set. </summary>
+ /// Returns an enumeration of all the <see cref="Term"/>s and <see cref="TermInfo"/>s in the set. </summary>
public SegmentTermEnum Terms()
{
return (SegmentTermEnum)origEnum.Clone();
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/95b5d4bb/src/Lucene.Net/Codecs/Lucene3x/TermInfosReaderIndex.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Codecs/Lucene3x/TermInfosReaderIndex.cs b/src/Lucene.Net/Codecs/Lucene3x/TermInfosReaderIndex.cs
index 14f3744..eb8c2c5 100644
--- a/src/Lucene.Net/Codecs/Lucene3x/TermInfosReaderIndex.cs
+++ b/src/Lucene.Net/Codecs/Lucene3x/TermInfosReaderIndex.cs
@@ -32,11 +32,10 @@ namespace Lucene.Net.Codecs.Lucene3x
using Term = Lucene.Net.Index.Term;
/// <summary>
- /// this stores a monotonically increasing set of <Term, TermInfo> pairs in an
- /// index segment. Pairs are accessed either by Term or by ordinal position the
- /// set. The Terms and TermInfo are actually serialized and stored into a byte
- /// array and pointers to the position of each are stored in a int array. </summary>
- /// @deprecated Only for reading existing 3.x indexes
+ /// This stores a monotonically increasing set of <c>Term, TermInfo</c> pairs in an
+ /// index segment. Pairs are accessed either by <see cref="Term"/> or by ordinal position the
+ /// set. The <see cref="Index.Terms"/> and <see cref="TermInfo"/> are actually serialized and stored into a byte
+ /// array and pointers to the position of each are stored in a <see cref="int"/> array. </summary>
[Obsolete("Only for reading existing 3.x indexes")]
internal class TermInfosReaderIndex
{
@@ -54,14 +53,14 @@ namespace Lucene.Net.Codecs.Lucene3x
/// Loads the segment information at segment load time.
/// </summary>
/// <param name="indexEnum">
- /// the term enum. </param>
+ /// The term enum. </param>
/// <param name="indexDivisor">
- /// the index divisor. </param>
+ /// The index divisor. </param>
/// <param name="tiiFileLength">
- /// the size of the tii file, used to approximate the size of the
+ /// The size of the tii file, used to approximate the size of the
/// buffer. </param>
/// <param name="totalIndexInterval">
- /// the total index interval. </param>
+ /// The total index interval. </param>
public TermInfosReaderIndex(SegmentTermEnum indexEnum, int indexDivisor, long tiiFileLength, int totalIndexInterval)
{
this.totalIndexInterval = totalIndexInterval;
@@ -161,8 +160,8 @@ namespace Lucene.Net.Codecs.Lucene3x
/// Binary search for the given term.
/// </summary>
/// <param name="term">
- /// the term to locate. </param>
- /// <exception cref="IOException"> If there is a low-level I/O error. </exception>
+ /// The term to locate. </param>
+ /// <exception cref="System.IO.IOException"> If there is a low-level I/O error. </exception>
internal virtual int GetIndexOffset(Term term)
{
int lo = 0;
@@ -193,9 +192,9 @@ namespace Lucene.Net.Codecs.Lucene3x
/// Gets the term at the given position. For testing.
/// </summary>
/// <param name="termIndex">
- /// the position to read the term from the index. </param>
- /// <returns> the term. </returns>
- /// <exception cref="IOException"> If there is a low-level I/O error. </exception>
+ /// The position to read the term from the index. </param>
+ /// <returns> The term. </returns>
+ /// <exception cref="System.IO.IOException"> If there is a low-level I/O error. </exception>
internal virtual Term GetTerm(int termIndex)
{
PagedBytesDataInput input = (PagedBytesDataInput)dataInput.Clone();
@@ -221,11 +220,11 @@ namespace Lucene.Net.Codecs.Lucene3x
/// term index. ie It returns negative N when term is less than index term;
/// </summary>
/// <param name="term">
- /// the given term. </param>
+ /// The given term. </param>
/// <param name="termIndex">
- /// the index of the of term to compare. </param>
+ /// The index of the of term to compare. </param>
/// <returns> int. </returns>
- /// <exception cref="IOException"> If there is a low-level I/O error. </exception>
+ /// <exception cref="System.IO.IOException"> If there is a low-level I/O error. </exception>
internal virtual int CompareTo(Term term, int termIndex)
{
return CompareTo(term, termIndex, (PagedBytesDataInput)dataInput.Clone(), new BytesRef());
@@ -236,13 +235,13 @@ namespace Lucene.Net.Codecs.Lucene3x
/// compare. If equal compare terms.
/// </summary>
/// <param name="term">
- /// the term to compare. </param>
+ /// The term to compare. </param>
/// <param name="termIndex">
- /// the position of the term in the input to compare </param>
+ /// The position of the term in the input to compare </param>
/// <param name="input">
- /// the input buffer. </param>
+ /// The input buffer. </param>
/// <returns> int. </returns>
- /// <exception cref="IOException"> If there is a low-level I/O error. </exception>
+ /// <exception cref="System.IO.IOException"> If there is a low-level I/O error. </exception>
private int CompareTo(Term term, int termIndex, PagedBytesDataInput input, BytesRef reuse)
{
// if term field does not equal mid's field index, then compare fields
@@ -262,13 +261,13 @@ namespace Lucene.Net.Codecs.Lucene3x
/// Compares the fields before checking the text of the terms.
/// </summary>
/// <param name="term">
- /// the given term. </param>
+ /// The given term. </param>
/// <param name="termIndex">
- /// the term that exists in the data block. </param>
+ /// The term that exists in the data block. </param>
/// <param name="input">
- /// the data block. </param>
+ /// The data block. </param>
/// <returns> int. </returns>
- /// <exception cref="IOException"> If there is a low-level I/O error. </exception>
+ /// <exception cref="System.IO.IOException"> If there is a low-level I/O error. </exception>
private int CompareField(Term term, int termIndex, PagedBytesDataInput input)
{
input.SetPosition(indexToDataOffset.Get(termIndex));