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 2021/11/23 09:30:09 UTC
[lucenenet] branch master updated: Lucene.Net.Replicator.IndexAndTaxonomyRevision: Updated documentation.
This is an automated email from the ASF dual-hosted git repository.
nightowl888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
The following commit(s) were added to refs/heads/master by this push:
new d6f10f7 Lucene.Net.Replicator.IndexAndTaxonomyRevision: Updated documentation.
d6f10f7 is described below
commit d6f10f7e7aa2e1530bca0fc20f8bb772bb5a11cb
Author: Shad Storhaug <sh...@shadstorhaug.com>
AuthorDate: Tue Nov 23 09:54:30 2021 +0700
Lucene.Net.Replicator.IndexAndTaxonomyRevision: Updated documentation.
---
src/Lucene.Net.Replicator/IndexAndTaxonomyRevision.cs | 18 ++++++------------
1 file changed, 6 insertions(+), 12 deletions(-)
diff --git a/src/Lucene.Net.Replicator/IndexAndTaxonomyRevision.cs b/src/Lucene.Net.Replicator/IndexAndTaxonomyRevision.cs
index 2d845a3..b395475 100644
--- a/src/Lucene.Net.Replicator/IndexAndTaxonomyRevision.cs
+++ b/src/Lucene.Net.Replicator/IndexAndTaxonomyRevision.cs
@@ -53,19 +53,13 @@ namespace Lucene.Net.Replicator
private SnapshotDeletionPolicy sdp;
private IndexWriter writer; // LUCENENET TODO: Why does disposing this in Dispose(true) throw an excpetion?
- /// <summary>
- /// <see cref="DirectoryTaxonomyWriter(Directory, OpenMode, ITaxonomyWriterCache)"/>
- /// </summary>
- /// <exception cref="IOException"></exception>
+ /// <inheritdoc/>
public SnapshotDirectoryTaxonomyWriter(Directory directory, OpenMode openMode, ITaxonomyWriterCache cache)
: base(directory, openMode, cache)
{
}
- /// <summary>
- /// <see cref="DirectoryTaxonomyWriter(Directory, OpenMode)"/>
- /// </summary>
- /// <exception cref="IOException"></exception>
+ /// <inheritdoc/>
public SnapshotDirectoryTaxonomyWriter(Directory directory, OpenMode openMode = OpenMode.CREATE_OR_APPEND)
: base(directory, openMode)
{
@@ -107,7 +101,6 @@ namespace Lucene.Net.Replicator
/// <summary>
/// Returns a map of the revision files from the given <see cref="IndexCommit"/>s of the search and taxonomy indexes.
/// </summary>
- /// <exception cref="IOException"></exception>
public static IDictionary<string, IList<RevisionFile>> RevisionFiles(IndexCommit indexCommit, IndexCommit taxonomyCommit)
{
return new Dictionary<string, IList<RevisionFile>>{
@@ -131,7 +124,8 @@ namespace Lucene.Net.Replicator
/// <see cref="IndexCommit"/> found in the <see cref="Directory"/> managed by the given
/// writer.
/// </summary>
- /// <exception cref="IOException"></exception>
+ /// <exception cref="InvalidOperationException">If this index does not have any commits yet.</exception>
+ /// <exception cref="ArgumentException">If the <see cref="IndexWriterConfig.IndexDeletionPolicy"/> is not a <see cref="SnapshotDeletionPolicy"/>.</exception>
public IndexAndTaxonomyRevision(IndexWriter indexWriter, SnapshotDirectoryTaxonomyWriter taxonomyWriter)
{
this.indexSdp = indexWriter.Config.IndexDeletionPolicy as SnapshotDeletionPolicy;
@@ -183,7 +177,7 @@ namespace Lucene.Net.Replicator
public virtual IDictionary<string, IList<RevisionFile>> SourceFiles => sourceFiles;
- /// <exception cref="IOException"></exception>
+ /// <exception cref="IOException">An IO exception occurred.</exception>
public virtual Stream Open(string source, string fileName)
{
if (Debugging.AssertsEnabled) Debugging.Assert(source.Equals(INDEX_SOURCE, StringComparison.Ordinal) || source.Equals(TAXONOMY_SOURCE, StringComparison.Ordinal), "invalid source; expected=({0} or {1}) got={2}", INDEX_SOURCE, TAXONOMY_SOURCE, source);
@@ -191,7 +185,7 @@ namespace Lucene.Net.Replicator
return new IndexInputStream(commit.Directory.OpenInput(fileName, IOContext.READ_ONCE));
}
- /// <exception cref="IOException"></exception>
+ /// <exception cref="IOException">An IO exception occurred.</exception>
public virtual void Release()
{
try