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:17 UTC
[44/48] lucenenet git commit: Lucene.Net: Fixed misc XML
documentation comment warnings
Lucene.Net: Fixed misc 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/5a0e4b68
Tree: http://git-wip-us.apache.org/repos/asf/lucenenet/tree/5a0e4b68
Diff: http://git-wip-us.apache.org/repos/asf/lucenenet/diff/5a0e4b68
Branch: refs/heads/master
Commit: 5a0e4b68a7822c86b6e0434c4a1875c98a98e034
Parents: 5dc5193
Author: Shad Storhaug <sh...@shadstorhaug.com>
Authored: Mon Jun 5 15:43:33 2017 +0700
Committer: Shad Storhaug <sh...@shadstorhaug.com>
Committed: Tue Jun 6 06:58:42 2017 +0700
----------------------------------------------------------------------
src/Lucene.Net/Index/DirectoryReader.cs | 13 ++++++-------
src/Lucene.Net/Index/DocValuesFieldUpdates.cs | 2 +-
src/Lucene.Net/Index/DocumentsWriterStallControl.cs | 4 ++--
src/Lucene.Net/Index/IndexDeletionPolicy.cs | 3 +--
src/Lucene.Net/Index/IndexWriter.cs | 2 +-
src/Lucene.Net/Index/IndexWriterConfig.cs | 2 +-
src/Lucene.Net/Store/ByteBufferIndexInput.cs | 2 +-
src/Lucene.Net/Store/DataOutput.cs | 4 ++--
src/Lucene.Net/Store/Lock.cs | 2 +-
src/Lucene.Net/Util/Fst/Builder.cs | 2 +-
src/Lucene.Net/Util/Fst/FST.cs | 10 +++++-----
src/Lucene.Net/Util/Fst/PositiveIntOutputs.cs | 4 ++--
12 files changed, 24 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Index/DirectoryReader.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Index/DirectoryReader.cs b/src/Lucene.Net/Index/DirectoryReader.cs
index d3cf4de..7056ce0 100644
--- a/src/Lucene.Net/Index/DirectoryReader.cs
+++ b/src/Lucene.Net/Index/DirectoryReader.cs
@@ -38,8 +38,7 @@ namespace Lucene.Net.Index
/// as documents are added to and deleted from an index. Clients should thus not
/// rely on a given document having the same number between sessions.
///
- /// <para/>
- /// <p><b>NOTE</b>:
+ /// <para/><b>NOTE</b>:
/// <see cref="IndexReader"/> instances are completely thread
/// safe, meaning multiple threads can call any of its methods,
/// concurrently. If your application requires external
@@ -127,8 +126,8 @@ namespace Lucene.Net.Index
}
/// <summary>
- /// Expert: returns an <see cref=""/>IndexReader reading the index in the given
- /// <seealso cref="IndexCommit"/> and <paramref name="termInfosIndexDivisor"/>. </summary>
+ /// Expert: returns an <see cref="IndexReader"/> reading the index in the given
+ /// <seealso cref="Index.IndexCommit"/> and <paramref name="termInfosIndexDivisor"/>. </summary>
/// <param name="commit"> the commit point to open </param>
/// <param name="termInfosIndexDivisor"> Subsamples which indexed
/// terms are loaded into RAM. this has the same effect as setting
@@ -462,14 +461,14 @@ namespace Lucene.Net.Index
/// Check whether any new changes have occurred to the
/// index since this reader was opened.
///
- /// <para>If this reader was created by calling <see cref="Open"/>,
+ /// <para>If this reader was created by calling an overload of <see cref="Open(Directory)"/>,
/// then this method checks if any further commits
/// (see <see cref="IndexWriter.Commit()"/>) have occurred in the
/// directory.</para>
///
/// <para>If instead this reader is a near real-time reader
/// (ie, obtained by a call to
- /// <see cref="DirectoryReader.Open(IndexWriter, bool)"/>, or by calling <see cref="OpenIfChanged"/>
+ /// <see cref="DirectoryReader.Open(IndexWriter, bool)"/>, or by calling an overload of <see cref="OpenIfChanged(DirectoryReader)"/>
/// on a near real-time reader), then this method checks if
/// either a new commit has occurred, or any new
/// uncommitted changes have taken place via the writer.
@@ -477,7 +476,7 @@ namespace Lucene.Net.Index
/// merging, this method will still return <c>false</c>.</para>
///
/// <para>In any event, if this returns <c>false</c>, you should call
- /// <see cref="OpenIfChanged"/> to get a new reader that sees the
+ /// an overload of <see cref="OpenIfChanged(DirectoryReader)"/> to get a new reader that sees the
/// changes.</para>
/// </summary>
/// <exception cref="IOException"> if there is a low-level IO error </exception>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Index/DocValuesFieldUpdates.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Index/DocValuesFieldUpdates.cs b/src/Lucene.Net/Index/DocValuesFieldUpdates.cs
index 81e5965..a16158f 100644
--- a/src/Lucene.Net/Index/DocValuesFieldUpdates.cs
+++ b/src/Lucene.Net/Index/DocValuesFieldUpdates.cs
@@ -63,7 +63,7 @@ namespace Lucene.Net.Index
/// <summary>
/// Reset the iterator's state. Should be called before <see cref="NextDoc()"/>
- /// and <seealso cref="#value()"/>.
+ /// and <see cref="Value"/>.
/// </summary>
public abstract void Reset();
}
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Index/DocumentsWriterStallControl.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Index/DocumentsWriterStallControl.cs b/src/Lucene.Net/Index/DocumentsWriterStallControl.cs
index 7dd1581..a0c844c 100644
--- a/src/Lucene.Net/Index/DocumentsWriterStallControl.cs
+++ b/src/Lucene.Net/Index/DocumentsWriterStallControl.cs
@@ -34,9 +34,9 @@ namespace Lucene.Net.Index
/// <para/>
/// To prevent OOM Errors and ensure <see cref="IndexWriter"/>'s stability this class blocks
/// incoming threads from indexing once 2 x number of available
- /// <see cref="ThreadState"/>s in <see cref="DocumentsWriterPerThreadPool"/> is exceeded.
+ /// <see cref="DocumentsWriterPerThreadPool.ThreadState"/> is exceeded.
/// Once flushing catches up and the number of flushing DWPT is equal or lower
- /// than the number of active <see cref="ThreadState"/>s threads are released and can
+ /// than the number of active <see cref="DocumentsWriterPerThreadPool.ThreadState"/>s threads are released and can
/// continue indexing.
/// </summary>
#if FEATURE_SERIALIZABLE
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Index/IndexDeletionPolicy.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Index/IndexDeletionPolicy.cs b/src/Lucene.Net/Index/IndexDeletionPolicy.cs
index 2c00bb7..d5daffe 100644
--- a/src/Lucene.Net/Index/IndexDeletionPolicy.cs
+++ b/src/Lucene.Net/Index/IndexDeletionPolicy.cs
@@ -70,8 +70,7 @@ namespace Lucene.Net.Index
/// <para>The writer locates all index commits present in the
/// index directory and calls this method. The policy may
/// choose to delete some of the commit points, doing so by
- /// calling method <seealso cref="IndexCommit#delete delete()"/>
- /// of <seealso cref="IndexCommit"/>.</para>
+ /// calling method <see cref="IndexCommit.Delete()"/>.</para>
///
/// <para><u>Note:</u> the last CommitPoint is the most recent one,
/// i.e. the "front index state". Be careful not to delete it,
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Index/IndexWriter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Index/IndexWriter.cs b/src/Lucene.Net/Index/IndexWriter.cs
index 618024c..0c81ccb 100644
--- a/src/Lucene.Net/Index/IndexWriter.cs
+++ b/src/Lucene.Net/Index/IndexWriter.cs
@@ -151,7 +151,7 @@ namespace Lucene.Net.Index
/// <para><b>NOTE</b>: If you call
/// <see cref="Thread.Interrupt()"/> on a thread that's within
/// <see cref="IndexWriter"/>, <see cref="IndexWriter"/> will try to catch this (eg, if
- /// it's in a Wait() or <see cref="Thread.Sleep()"/>), and will then throw
+ /// it's in a Wait() or <see cref="Thread.Sleep(int)"/>), and will then throw
/// the unchecked exception <see cref="ThreadInterruptedException"/>
/// and <b>clear</b> the interrupt status on the thread.</para>
/// </summary>
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Index/IndexWriterConfig.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Index/IndexWriterConfig.cs b/src/Lucene.Net/Index/IndexWriterConfig.cs
index ffc21c2..b2ed2b8 100644
--- a/src/Lucene.Net/Index/IndexWriterConfig.cs
+++ b/src/Lucene.Net/Index/IndexWriterConfig.cs
@@ -155,7 +155,7 @@ namespace Lucene.Net.Index
/// <summary>
/// Gets or sets the <see cref="IndexWriter"/> this config is attached to.
/// </summary>
- /// <exception cref="Util.SetOnce{T}.AlreadySetException">
+ /// <exception cref="Util.AlreadySetException">
/// if this config is already attached to a writer. </exception>
internal IndexWriterConfig SetIndexWriter(IndexWriter writer)
{
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Store/ByteBufferIndexInput.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Store/ByteBufferIndexInput.cs b/src/Lucene.Net/Store/ByteBufferIndexInput.cs
index 629b5d0..9827473 100644
--- a/src/Lucene.Net/Store/ByteBufferIndexInput.cs
+++ b/src/Lucene.Net/Store/ByteBufferIndexInput.cs
@@ -312,7 +312,7 @@ namespace Lucene.Net.Store
/// <summary>
/// Returns a sliced view from a set of already-existing buffers:
- /// the last buffer's <see cref="Support.Buffer.Limit"/> will be correct, but
+ /// the last buffer's <see cref="Support.IO.Buffer.Limit"/> will be correct, but
/// you must deal with <paramref name="offset"/> separately (the first buffer will not be adjusted)
/// </summary>
private ByteBuffer[] BuildSlice(ByteBuffer[] buffers, long offset, long length)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Store/DataOutput.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Store/DataOutput.cs b/src/Lucene.Net/Store/DataOutput.cs
index 7fe27e2..940439f 100644
--- a/src/Lucene.Net/Store/DataOutput.cs
+++ b/src/Lucene.Net/Store/DataOutput.cs
@@ -43,7 +43,7 @@ namespace Lucene.Net.Store
/// accessed as sequences of bytes. All other data types are defined
/// as sequences of bytes, so file formats are byte-order independent.
/// </summary>
- /// <seealso cref="IndexInput.ReadByte()"/>
+ /// <seealso cref="DataInput.ReadByte()"/>
public abstract void WriteByte(byte b);
/// <summary>
@@ -215,7 +215,7 @@ namespace Lucene.Net.Store
/// <para/>
/// NOTE: this was writeLong() in Lucene
/// </summary>
- /// <seealso cref="DataInput.ReadLong()"/>
+ /// <seealso cref="DataInput.ReadInt64()"/>
public virtual void WriteInt64(long i)
{
WriteInt32((int)(i >> 32));
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Store/Lock.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Store/Lock.cs b/src/Lucene.Net/Store/Lock.cs
index f09aee9..9f37acc 100644
--- a/src/Lucene.Net/Store/Lock.cs
+++ b/src/Lucene.Net/Store/Lock.cs
@@ -51,7 +51,7 @@ namespace Lucene.Net.Store
public const long LOCK_OBTAIN_WAIT_FOREVER = -1;
/// <summary>
- /// Creates a new instance with the ability to specify the <see cref="With.DoBody()"/> method
+ /// Creates a new instance with the ability to specify the <see cref="With{T}.DoBody()"/> method
/// through the <paramref name="doBody"/> argument
/// <para/>
/// Simple example:
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Util/Fst/Builder.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Util/Fst/Builder.cs b/src/Lucene.Net/Util/Fst/Builder.cs
index 418f724..c7eb080 100644
--- a/src/Lucene.Net/Util/Fst/Builder.cs
+++ b/src/Lucene.Net/Util/Fst/Builder.cs
@@ -99,7 +99,7 @@ namespace Lucene.Net.Util.Fst
/// <summary>
/// Instantiates an FST/FSA builder without any pruning. A shortcut
- /// to <see cref="Builder.Builder(FST.INPUT_TYPE, int, int, bool, bool, int, Outputs{T}, FreezeTail{T}, bool, float, bool, int)"/>
+ /// to <see cref="Builder{T}.Builder(FST.INPUT_TYPE, int, int, bool, bool, int, Outputs{T}, FreezeTail{T}, bool, float, bool, int)"/>
/// with pruning options turned off.
/// </summary>
public Builder(FST.INPUT_TYPE inputType, Outputs<T> outputs)
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Util/Fst/FST.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Util/Fst/FST.cs b/src/Lucene.Net/Util/Fst/FST.cs
index dfefd63..e85af58 100644
--- a/src/Lucene.Net/Util/Fst/FST.cs
+++ b/src/Lucene.Net/Util/Fst/FST.cs
@@ -1069,9 +1069,9 @@ namespace Lucene.Net.Util.Fst
}
/// <summary>
- /// Checks if <paramref name="arc"/>'s target state is in expanded (or vector) format.
+ /// Checks if arc's target state is in expanded (or vector) format.
/// </summary>
- /// <returns> Returns <c>true</c> if <paramref name="arc"/> points to a state in an
+ /// <returns> Returns <c>true</c> if arc points to a state in an
/// expanded array format. </returns>
internal bool IsExpandedTarget(FST.Arc<T> follow, FST.BytesReader @in)
{
@@ -2105,17 +2105,17 @@ namespace Lucene.Net.Util.Fst
internal const sbyte ARCS_AS_FIXED_ARRAY = BIT_ARC_HAS_FINAL_OUTPUT;
/// <summary>
- /// <see cref="Builder{T}.UnCompiledNode{S}"/>
+ /// <see cref="Builder.UnCompiledNode{S}"/>
/// </summary>
public const int FIXED_ARRAY_SHALLOW_DISTANCE = 3;
/// <summary>
- /// <see cref="Builder{T}.UnCompiledNode{S}"/>
+ /// <see cref="Builder.UnCompiledNode{S}"/>
/// </summary>
public const int FIXED_ARRAY_NUM_ARCS_SHALLOW = 5;
/// <summary>
- /// <see cref="Builder{T}.UnCompiledNode{S}"/>
+ /// <see cref="Builder.UnCompiledNode{S}"/>
/// </summary>
public const int FIXED_ARRAY_NUM_ARCS_DEEP = 10;
http://git-wip-us.apache.org/repos/asf/lucenenet/blob/5a0e4b68/src/Lucene.Net/Util/Fst/PositiveIntOutputs.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net/Util/Fst/PositiveIntOutputs.cs b/src/Lucene.Net/Util/Fst/PositiveIntOutputs.cs
index 8897054..bf343ed 100644
--- a/src/Lucene.Net/Util/Fst/PositiveIntOutputs.cs
+++ b/src/Lucene.Net/Util/Fst/PositiveIntOutputs.cs
@@ -25,10 +25,10 @@ namespace Lucene.Net.Util.Fst
/// <summary>
/// An FST <see cref="Outputs{T}"/> implementation where each output
- /// is a non-negative <see cref="long?"/> value.
+ /// is a non-negative <see cref="T:long?"/> value.
/// <para/>
/// NOTE: This was PositiveIntOutputs in Lucene
- ///
+ /// <para/>
/// @lucene.experimental
/// </summary>
public sealed class PositiveInt32Outputs : Outputs<long?>