lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject [06/27] lucenenet git commit: Lucene.Net.Highlighter: fix documentation comment formatting problems
Date Sun, 05 Feb 2017 16:51:41 GMT
Lucene.Net.Highlighter: fix documentation comment formatting problems


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

Branch: refs/heads/api-work
Commit: 27217597c3678e62ab04609de50ae37c7885e2ba
Parents: 1b9fe40
Author: Shad Storhaug <shad@shadstorhaug.com>
Authored: Sun Feb 5 12:26:47 2017 +0700
Committer: Shad Storhaug <shad@shadstorhaug.com>
Committed: Sun Feb 5 14:47:49 2017 +0700

----------------------------------------------------------------------
 .../Highlight/WeightedSpanTermExtractor.cs        | 16 ++++++++--------
 .../PostingsHighlight/PassageScorer.cs            |  8 ++++----
 .../PostingsHighlight/PostingsHighlighter.cs      | 18 +++++++++---------
 .../VectorHighlight/FieldTermStack.cs             |  2 +-
 .../VectorHighlight/FragmentsBuilder.cs           |  8 ++++----
 5 files changed, 26 insertions(+), 26 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27217597/src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs b/src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs
index 3de333f..c31005e 100644
--- a/src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs
+++ b/src/Lucene.Net.Highlighter/Highlight/WeightedSpanTermExtractor.cs
@@ -56,7 +56,7 @@ namespace Lucene.Net.Search.Highlight
         }
 
         /// <summary>
-        /// Fills a <see cref="IDictionary{string, WeightedSpanTerm}"/> with <see
cref="WeightedSpanTerm"/>s using the terms from the supplied <paramref name="query"/>.
+        /// Fills a <see cref="T:IDictionary{string, WeightedSpanTerm}"/> with <see
cref="WeightedSpanTerm"/>s using the terms from the supplied <paramref name="query"/>.
         /// </summary>
         /// <param name="query"><see cref="Query"/> to extract Terms from</param>
         /// <param name="terms">Map to place created <see cref="WeightedSpanTerm"/>s
in</param>
@@ -237,9 +237,9 @@ namespace Lucene.Net.Search.Highlight
         }
 
         /// <summary>
-        /// Fills a <see cref="IDictionary{string, WeightedSpanTerm}"/> with <see
cref="WeightedSpanTerm"/>s using the terms from the supplied <see cref="SpanQuery"/>.
+        /// Fills a <see cref="T:IDictionary{string, WeightedSpanTerm}"/> with <see
cref="WeightedSpanTerm"/>s using the terms from the supplied <see cref="SpanQuery"/>.
         /// </summary>
-        /// <param name="terms"><see cref="IDictionary{string, WeightedSpanTerm}"/>
to place created <see cref="WeightedSpanTerm"/>s in</param>
+        /// <param name="terms"><see cref="T:IDictionary{string, WeightedSpanTerm}"/>
to place created <see cref="WeightedSpanTerm"/>s in</param>
         /// <param name="spanQuery"><see cref="SpanQuery"/> to extract Terms
from</param>
         /// <exception cref="System.IO.IOException">If there is a low-level I/O error</exception>
         protected virtual void ExtractWeightedSpanTerms(IDictionary<string, WeightedSpanTerm>
terms, SpanQuery spanQuery)
@@ -335,10 +335,10 @@ namespace Lucene.Net.Search.Highlight
         }
 
         /// <summary>
-        /// Fills a <see cref="IDictionary{string, WeightedSpanTerm}"/> with <see
cref="WeightedSpanTerm"/>s using the terms from 
+        /// Fills a <see cref="T:IDictionary{string, WeightedSpanTerm}"/> with <see
cref="WeightedSpanTerm"/>s using the terms from 
         /// the supplied <see cref="Search.Spans.SpanQuery"/>.
         /// </summary>
-        /// <param name="terms"><see cref="IDictionary{string, WeightedSpanTerm}"/>
to place created <see cref="WeightedSpanTerm"/>s in</param>
+        /// <param name="terms"><see cref="T:IDictionary{string, WeightedSpanTerm}"/>
to place created <see cref="WeightedSpanTerm"/>s in</param>
         /// <param name="query"><see cref="Query"/> to extract Terms from</param>
         /// <exception cref="System.IO.IOException">If there is a low-level I/O error</exception>
         protected virtual void ExtractWeightedTerms(IDictionary<string, WeightedSpanTerm>
terms, Query query)
@@ -462,7 +462,7 @@ namespace Lucene.Net.Search.Highlight
         }
 
         /// <summary>
-        /// Creates an <see cref="IDictionary{string, WeightedSpanTerm}"/> from the
given <see cref="Query"/> and <see cref="Analysis.TokenStream"/>.
+        /// Creates an <see cref="T:IDictionary{string, WeightedSpanTerm}"/> from the
given <see cref="Query"/> and <see cref="Analysis.TokenStream"/>.
         /// </summary>
         /// <param name="query"><see cref="Query"/> that caused hit</param>
         /// <param name="tokenStream"><see cref="Analysis.TokenStream"/> of text
to be highlighted</param>
@@ -475,7 +475,7 @@ namespace Lucene.Net.Search.Highlight
 
 
         /// <summary>
-        /// Creates an <see cref="IDictionary{string, WeightedSpanTerm}"/> from the
given <see cref="Query"/> and <see cref="Analysis.TokenStream"/>.
+        /// Creates an <see cref="T:IDictionary{string, WeightedSpanTerm}"/> from the
given <see cref="Query"/> and <see cref="Analysis.TokenStream"/>.
         /// </summary>
         /// <param name="query"><see cref="Query"/> that caused hit</param>
         /// <param name="tokenStream"><see cref="Analysis.TokenStream"/> of text
to be highlighted</param>
@@ -509,7 +509,7 @@ namespace Lucene.Net.Search.Highlight
         }
 
         /// <summary>
-        /// Creates an <see cref="IDictionary{string, WeightedSpanTerm}"/> from the
given <see cref="Query"/> and <see cref="Analysis.TokenStream"/>. Uses a supplied
+        /// Creates an <see cref="T:IDictionary{string, WeightedSpanTerm}"/> from the
given <see cref="Query"/> and <see cref="Analysis.TokenStream"/>. Uses a supplied
         /// <see cref="IndexReader"/> to properly Weight terms (for gradient highlighting).
         /// </summary>
         /// <param name="query"><see cref="Query"/> that caused hit</param>

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27217597/src/Lucene.Net.Highlighter/PostingsHighlight/PassageScorer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Highlighter/PostingsHighlight/PassageScorer.cs b/src/Lucene.Net.Highlighter/PostingsHighlight/PassageScorer.cs
index a1a4e35..af398da 100644
--- a/src/Lucene.Net.Highlighter/PostingsHighlight/PassageScorer.cs
+++ b/src/Lucene.Net.Highlighter/PostingsHighlight/PassageScorer.cs
@@ -23,7 +23,7 @@ namespace Lucene.Net.Search.PostingsHighlight
     /// Ranks passages found by <see cref="PostingsHighlighter"/>.
     /// <para/>
     /// Each passage is scored as a miniature document within the document.
-    /// The final score is computed as <c>norm</c> * &sum; (<c>weight</c>
* <c>tf</c>).
+    /// The final score is computed as <c>norm</c> * ∑ (<c>weight</c>
* <c>tf</c>).
     /// The default implementation is <c>norm</c> * BM25.
     /// 
     /// @lucene.experimental
@@ -42,9 +42,9 @@ namespace Lucene.Net.Search.PostingsHighlight
         /// <summary>
         /// Creates <see cref="PassageScorer"/> with these default values:
         /// <list type="bullet">
-        ///     <item><paramref name="k1"/> = 1.2</item>
-        ///     <item><paramref name="b"/> = 0.75</item>
-        ///     <item><paramref name="pivot"/> = 87</item>
+        ///     <item><c>k1 = 1.2</c></item>
+        ///     <item><c>b = 0.75</c></item>
+        ///     <item><c>pivot = 87</c></item>
         /// </list>
         /// </summary>
         public PassageScorer()

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27217597/src/Lucene.Net.Highlighter/PostingsHighlight/PostingsHighlighter.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Highlighter/PostingsHighlight/PostingsHighlighter.cs b/src/Lucene.Net.Highlighter/PostingsHighlight/PostingsHighlighter.cs
index db04ee1..758a33a 100644
--- a/src/Lucene.Net.Highlighter/PostingsHighlight/PostingsHighlighter.cs
+++ b/src/Lucene.Net.Highlighter/PostingsHighlight/PostingsHighlighter.cs
@@ -231,13 +231,13 @@ namespace Lucene.Net.Search.PostingsHighlight
         /// <param name="searcher">searcher that was previously used to execute the
query.</param>
         /// <param name="topDocs">TopDocs containing the summary result documents to
highlight.</param>
         /// <returns>
-        /// <see cref="IDictionary{string, string[]}"/> keyed on field name, containing
the array of formatted snippets 
+        /// <see cref="T:IDictionary{string, string[]}"/> keyed on field name, containing
the array of formatted snippets 
         /// corresponding to the documents in <paramref name="topDocs"/>.
         /// If no highlights were found for a document, the
         /// first sentence from the field will be returned.
         /// </returns>
         /// <exception cref="IOException">if an I/O error occurred during processing</exception>
-        /// <exception cref="ArgumentException">if <paramref name="field"/> was
indexed without <see cref="IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/></exception>
+        /// <exception cref="ArgumentException">if <c>field</c> was indexed
without <see cref="IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/></exception>
         public virtual IDictionary<string, string[]> HighlightFields(string[] fields,
Query query, IndexSearcher searcher, TopDocs topDocs)
         {
             int[] maxPassages = new int[fields.Length];
@@ -264,14 +264,14 @@ namespace Lucene.Net.Search.PostingsHighlight
         /// <param name="topDocs">TopDocs containing the summary result documents to
highlight.</param>
         /// <param name="maxPassages">The maximum number of top-N ranked passages per-field
used to form the highlighted snippets.</param>
         /// <returns>
-        /// <see cref="IDictionary{string, string[]}"/> keyed on field name, containing
the array of formatted snippets
+        /// <see cref="T:IDictionary{string, string[]}"/> keyed on field name, containing
the array of formatted snippets
         /// corresponding to the documents in <paramref name="topDocs"/>.
         /// If no highlights were found for a document, the
         /// first <paramref name="maxPassages"/> sentences from the
         /// field will be returned.
         /// </returns>
         /// <exception cref="IOException">if an I/O error occurred during processing</exception>
-        /// <exception cref="ArgumentException">if <paramref name="field"/> was
indexed without <see cref="IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/></exception>
+        /// <exception cref="ArgumentException">if <c>field</c> was indexed
without <see cref="IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/></exception>
         public virtual IDictionary<string, string[]> HighlightFields(string[] fields,
Query query, IndexSearcher searcher, TopDocs topDocs, int[] maxPassages)
         {
             ScoreDoc[] scoreDocs = topDocs.ScoreDocs;
@@ -294,14 +294,14 @@ namespace Lucene.Net.Search.PostingsHighlight
         /// <param name="docidsIn">containing the document IDs to highlight.</param>
         /// <param name="maxPassagesIn">The maximum number of top-N ranked passages
per-field used to form the highlighted snippets.</param>
         /// <returns>
-        /// <see cref="IDictionary{string, string[]}"/> keyed on field name, containing
the array of formatted snippets 
+        /// <see cref="F:IDictionary{string, string[]}"/> keyed on field name, containing
the array of formatted snippets 
         /// corresponding to the documents in <paramref name="docidsIn"/>.
         /// If no highlights were found for a document, the
-        /// first <paramref name="maxPassages"/> from the field will
+        /// first <c>maxPassages</c> from the field will
         /// be returned.
         /// </returns>
         /// <exception cref="IOException">if an I/O error occurred during processing</exception>
-        /// <exception cref="ArgumentException">if <paramref name="field"/> was
indexed without <see cref="IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/></exception>
+        /// <exception cref="ArgumentException">if <c>field</c> was indexed
without <see cref="IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/></exception>
         public virtual IDictionary<string, string[]> HighlightFields(string[] fieldsIn,
Query query, IndexSearcher searcher, int[] docidsIn, int[] maxPassagesIn)
         {
             IDictionary<string, string[]> snippets = new Dictionary<string, string[]>();
@@ -361,14 +361,14 @@ namespace Lucene.Net.Search.PostingsHighlight
         /// <param name="docidsIn">containing the document IDs to highlight.</param>
         /// <param name="maxPassagesIn">The maximum number of top-N ranked passages
per-field used to form the highlighted snippets.</param>
         /// <returns>
-        /// <see cref="IDictionary{string, object[]}"/> keyed on field name, containing
the array of formatted snippets
+        /// <see cref="T:IDictionary{string, object[]}"/> keyed on field name, containing
the array of formatted snippets
         /// corresponding to the documents in <paramref name="docidsIn"/>.
         /// If no highlights were found for a document, the
         /// first <paramref name="maxPassagesIn"/> from the field will
         /// be returned.
         /// </returns>
         /// <exception cref="IOException">if an I/O error occurred during processing</exception>
-        /// <exception cref="ArgumentException">if <paramref name="field"/> was
indexed without <see cref="IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/></exception>
+        /// <exception cref="ArgumentException">if <c>field</c> was indexed
without <see cref="IndexOptions.DOCS_AND_FREQS_AND_POSITIONS_AND_OFFSETS"/></exception>
         protected internal virtual IDictionary<string, object[]> HighlightFieldsAsObjects(string[]
fieldsIn, Query query, IndexSearcher searcher, int[] docidsIn, int[] maxPassagesIn)
         {
             if (fieldsIn.Length < 1)

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27217597/src/Lucene.Net.Highlighter/VectorHighlight/FieldTermStack.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Highlighter/VectorHighlight/FieldTermStack.cs b/src/Lucene.Net.Highlighter/VectorHighlight/FieldTermStack.cs
index 7b326f1..9b8b8e6 100644
--- a/src/Lucene.Net.Highlighter/VectorHighlight/FieldTermStack.cs
+++ b/src/Lucene.Net.Highlighter/VectorHighlight/FieldTermStack.cs
@@ -65,7 +65,7 @@ namespace Lucene.Net.Search.VectorHighlight
         /// <param name="docId">document id to be highlighted</param>
         /// <param name="fieldName">field of the document to be highlighted</param>
         /// <param name="fieldQuery"><see cref="FieldQuery"/> object</param>
-        /// <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>
         public FieldTermStack(IndexReader reader, int docId, string fieldName, FieldQuery
fieldQuery)
         {
             this.fieldName = fieldName;

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/27217597/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs b/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs
index 343a060..534c9fb 100644
--- a/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs
+++ b/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs
@@ -35,7 +35,7 @@ namespace Lucene.Net.Search.VectorHighlight
         /// <param name="fieldName">field of the document to be highlighted</param>
         /// <param name="fieldFragList"><see cref="FieldFragList"/> object</param>
         /// <returns>a created fragment or null when no fragment created</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>
         string CreateFragment(IndexReader reader, int docId, string fieldName,
             FieldFragList fieldFragList);
 
@@ -51,7 +51,7 @@ namespace Lucene.Net.Search.VectorHighlight
         /// created fragments or null when no fragments created.
         /// size of the array can be less than <paramref name="maxNumFragments"/>
         /// </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>
         string[] CreateFragments(IndexReader reader, int docId, string fieldName,
             FieldFragList fieldFragList, int maxNumFragments);
 
@@ -66,7 +66,7 @@ namespace Lucene.Net.Search.VectorHighlight
         /// <param name="postTags">post-tags to be used to highlight terms</param>
         /// <param name="encoder">an encoder that generates encoded text</param>
         /// <returns>a created fragment or null when no fragment created</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>
         string CreateFragment(IndexReader reader, int docId, string fieldName,
             FieldFragList fieldFragList, string[] preTags, string[] postTags,
             IEncoder encoder);
@@ -86,7 +86,7 @@ namespace Lucene.Net.Search.VectorHighlight
         /// created fragments or null when no fragments created.
         /// size of the array can be less than <paramref name="maxNumFragments"/>
         /// </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>
         string[] CreateFragments(IndexReader reader, int docId, string fieldName,
             FieldFragList fieldFragList, int maxNumFragments, string[] preTags, string[]
postTags,
             IEncoder encoder);


Mime
View raw message