lucenenet-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nightowl...@apache.org
Subject [04/11] lucenenet git commit: Lucene.Net.Expressions: documentation comments
Date Thu, 26 Jan 2017 11:12:17 GMT
Lucene.Net.Expressions: documentation comments


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

Branch: refs/heads/api-work
Commit: 8ade0b432f7775f7a790d1fce2398ae4b905383d
Parents: fa4ab1b
Author: Shad Storhaug <shad@shadstorhaug.com>
Authored: Thu Jan 26 15:40:45 2017 +0700
Committer: Shad Storhaug <shad@shadstorhaug.com>
Committed: Thu Jan 26 15:40:45 2017 +0700

----------------------------------------------------------------------
 src/Lucene.Net.Expressions/Bindings.cs          | 21 +++--
 src/Lucene.Net.Expressions/Expression.cs        | 52 +++++-------
 .../ExpressionFunctionValues.cs                 |  5 +-
 .../ExpressionRescorer.cs                       | 22 ++---
 .../ExpressionSortField.cs                      |  5 +-
 .../ExpressionValueSource.cs                    | 10 +--
 .../JS/JavascriptCompiler.cs                    | 84 +++++++-------------
 .../ScoreFunctionValues.cs                      |  4 +-
 src/Lucene.Net.Expressions/ScoreValueSource.cs  | 17 ++--
 src/Lucene.Net.Expressions/SimpleBindings.cs    | 39 ++++-----
 10 files changed, 91 insertions(+), 168 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/Bindings.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/Bindings.cs b/src/Lucene.Net.Expressions/Bindings.cs
index 4cfdcdc..ee7f22d 100644
--- a/src/Lucene.Net.Expressions/Bindings.cs
+++ b/src/Lucene.Net.Expressions/Bindings.cs
@@ -22,11 +22,11 @@ namespace Lucene.Net.Expressions
     /// <summary>Binds variable names in expressions to actual data.</summary>
     /// <remarks>
     /// Binds variable names in expressions to actual data.
-    /// <p>
+    /// <para/>
     /// These are typically DocValues fields/FieldCache, the document's
-    /// relevance score, or other ValueSources.
+    /// relevance score, or other <see cref="ValueSource"/>s.
+    /// @lucene.experimental
     /// </remarks>
-    /// <lucene.experimental></lucene.experimental>
     public abstract class Bindings
 	{
 		/// <summary>Sole constructor.</summary>
@@ -38,16 +38,15 @@ namespace Lucene.Net.Expressions
 		{
 		}
 
-		/// <summary>Returns a ValueSource bound to the variable name.</summary>
-		
+		/// <summary>
+        /// Returns a <see cref="ValueSource"/> bound to the variable name.
+        /// </summary>
 		public abstract ValueSource GetValueSource(string name);
 
-		/// <summary>
-		/// Returns a
-		/// <code>ValueSource</code>
-		/// over relevance scores
-		/// </summary>
-		protected ValueSource GetScoreValueSource()
+        /// <summary>
+        /// Returns a <see cref="ValueSource"/> over relevance scores
+        /// </summary>
+        protected ValueSource GetScoreValueSource()
 		{
 			return new ScoreValueSource();
 		}

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/Expression.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/Expression.cs b/src/Lucene.Net.Expressions/Expression.cs
index 5eadc60..88ef269 100644
--- a/src/Lucene.Net.Expressions/Expression.cs
+++ b/src/Lucene.Net.Expressions/Expression.cs
@@ -23,23 +23,23 @@ namespace Lucene.Net.Expressions
     /// <summary>Base class that computes the value of an expression for a document.</summary>
     /// <remarks>
     /// Base class that computes the value of an expression for a document.
-    /// <p>
+    /// <para/>
     /// Example usage:
-    /// <pre class="prettyprint">
+    /// <code>
     /// // compile an expression:
-    /// Expression expr = JavascriptCompiler.compile("sqrt(_score) + ln(popularity)");
+    /// Expression expr = JavascriptCompiler.Compile("sqrt(_score) + ln(popularity)");
     /// // SimpleBindings just maps variables to SortField instances
     /// SimpleBindings bindings = new SimpleBindings();
-    /// bindings.add(new SortField("_score", SortField.Type.SCORE));
-    /// bindings.add(new SortField("popularity", SortField.Type.INT));
+    /// bindings.Add(new SortField("_score", SortFieldType.SCORE));
+    /// bindings.Add(new SortField("popularity", SortFieldType.INT));
     /// // create a sort field and sort by it (reverse order)
-    /// Sort sort = new Sort(expr.getSortField(bindings, true));
+    /// Sort sort = new Sort(expr.GetSortField(bindings, true));
     /// Query query = new TermQuery(new Term("body", "contents"));
-    /// searcher.search(query, null, 10, sort);
-    /// </pre>
+    /// searcher.Search(query, null, 10, sort);
+    /// </code>
+    /// @lucene.experimental
     /// </remarks>
-    /// <seealso cref="Lucene.Net.Expressions.JS.JavascriptCompiler.Compile(string)">Lucene.Net.Expressions.JS.JavascriptCompiler.Compile(string)</seealso>
-    /// <lucene.experimental></lucene.experimental>
+    /// <seealso cref="Lucene.Net.Expressions.JS.JavascriptCompiler.Compile(string)"/>
     public abstract class Expression
 	{
 		/// <summary>The original source text</summary>
@@ -49,13 +49,11 @@ namespace Lucene.Net.Expressions
         public readonly string[] variables; // LUCENENET TODO: Make property
 
         /// <summary>
-        /// Creates a new
-        /// <code>Expression</code>
-        /// .
+        /// Creates a new <see cref="Expression"/>.
         /// </summary>
         /// <param name="sourceText">
         /// Source text for the expression: e.g.
-        /// <code>ln(popularity)</code>
+        /// <c>ln(popularity)</c>
         /// </param>
         /// <param name="variables">
         /// Names of external variables referred to by the expression
@@ -69,22 +67,16 @@ namespace Lucene.Net.Expressions
 
 		/// <summary>Evaluates the expression for the given document.</summary>
 		/// <remarks>Evaluates the expression for the given document.</remarks>
-		/// <param name="document"><code>docId</code> of the document to compute
a value for</param>
+		/// <param name="document"><c>docId</c> of the document to compute a
value for</param>
 		/// <param name="functionValues">
-		/// 
-		/// <see cref="Lucene.Net.Queries.Function.FunctionValues">Lucene.Net.Queries.Function.FunctionValues
-		/// 	</see>
-		/// for each element of
-		/// <see cref="variables">variables</see>
-		/// .
+        /// <see cref="Lucene.Net.Queries.Function.FunctionValues"/>
+		/// for each element of <see cref="variables">variables</see>.
 		/// </param>
 		/// <returns>The computed value of the expression for the given document.</returns>
 		public abstract double Evaluate(int document, FunctionValues[] functionValues);
 
-		/// <summary>Get a value source which can compute the value of this expression in
the context of the given bindings.
-		/// 	</summary>
-		/// <remarks>Get a value source which can compute the value of this expression in
the context of the given bindings.
-		/// 	</remarks>
+		/// <summary>Get a value source which can compute the value of this expression in
the context of the given bindings.</summary>
+		/// <remarks>Get a value source which can compute the value of this expression in
the context of the given bindings.</remarks>
 		/// <param name="bindings">Bindings to use for external values in this expression</param>
 		/// <returns>A value source which will evaluate this expression when used</returns>
 		public virtual ValueSource GetValueSource(Bindings bindings)
@@ -92,19 +84,15 @@ namespace Lucene.Net.Expressions
 			return new ExpressionValueSource(bindings, this);
 		}
 
-		/// <summary>Get a sort field which can be used to rank documents by this expression.
-		/// 	</summary>
-		/// <remarks>Get a sort field which can be used to rank documents by this expression.
-		/// 	</remarks>
+		/// <summary>Get a sort field which can be used to rank documents by this expression.</summary>
+		/// <remarks>Get a sort field which can be used to rank documents by this expression.</remarks>
 		public virtual SortField GetSortField(Bindings bindings, bool reverse)
 		{
 			return GetValueSource(bindings).GetSortField(reverse);
 		}
 
 		/// <summary>
-		/// Get a
-		/// <see cref="Lucene.Net.Search.Rescorer">Lucene.Net.Search.Rescorer</see>
-		/// , to rescore first-pass hits
+		/// Get a <see cref="Lucene.Net.Search.Rescorer"/>, to rescore first-pass hits
 		/// using this expression.
 		/// </summary>
 		public virtual Rescorer GetRescorer(Bindings bindings)

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/ExpressionFunctionValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/ExpressionFunctionValues.cs b/src/Lucene.Net.Expressions/ExpressionFunctionValues.cs
index b6de614..453e066 100644
--- a/src/Lucene.Net.Expressions/ExpressionFunctionValues.cs
+++ b/src/Lucene.Net.Expressions/ExpressionFunctionValues.cs
@@ -22,10 +22,7 @@ namespace Lucene.Net.Expressions
      */
 
     /// <summary>
-    /// A
-    /// <see cref="Lucene.Net.Queries.Function.FunctionValues">Lucene.Net.Queries.Function.FunctionValues
-    /// 	</see>
-    /// which evaluates an expression
+    /// A <see cref="Lucene.Net.Queries.Function.FunctionValues"/> which evaluates
an expression
     /// </summary>
     internal class ExpressionFunctionValues : DoubleDocValues
 	{

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/ExpressionRescorer.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/ExpressionRescorer.cs b/src/Lucene.Net.Expressions/ExpressionRescorer.cs
index 78ef4f5..bd3de3e 100644
--- a/src/Lucene.Net.Expressions/ExpressionRescorer.cs
+++ b/src/Lucene.Net.Expressions/ExpressionRescorer.cs
@@ -23,32 +23,22 @@ namespace Lucene.Net.Expressions
      */
 
     /// <summary>
-    /// A
-    /// <see cref="Lucene.Net.Search.Rescorer">Lucene.Net.Search.Rescorer</see>
-    /// that uses an expression to re-score
+    /// A <see cref="Lucene.Net.Search.Rescorer"/> that uses an expression to re-score
     /// first pass hits.  Functionally this is the same as
-    /// <see cref="Lucene.Net.Search.SortRescorer">Lucene.Net.Search.SortRescorer
-    /// 	</see>
-    /// (if you build the
-    /// <see cref="Lucene.Net.Search.Sort">Lucene.Net.Search.Sort</see>
-    /// using
-    /// <see cref="Expression.GetSortField(Bindings, bool)">Expression.GetSortField(Bindings,
bool)
-    /// 	</see>
-    /// ), except for the explain method
+    /// <see cref="Lucene.Net.Search.SortRescorer"/> (if you build the
+    /// <see cref="Lucene.Net.Search.Sort"/> using
+    /// <see cref="Expression.GetSortField(Bindings, bool)"/>), except for the <see
cref="Explain"/> method
     /// which gives more detail by showing the value of each
     /// variable.
+    /// @lucene.experimental
     /// </summary>
-    /// <lucene.experimental></lucene.experimental>
     internal class ExpressionRescorer : SortRescorer
     {
         private readonly Expression expression;
         private readonly Bindings bindings;
 
         /// <summary>
-        /// Uses the provided
-        /// <see cref="Lucene.Net.Queries.Function.ValueSource">Lucene.Net.Queries.Function.ValueSource
-        /// 	</see>
-        /// to assign second
+        /// Uses the provided <see cref="Lucene.Net.Queries.Function.ValueSource"/>
to assign second
         /// pass scores.
         /// </summary>
         public ExpressionRescorer(Expression expression, Bindings bindings)

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/ExpressionSortField.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/ExpressionSortField.cs b/src/Lucene.Net.Expressions/ExpressionSortField.cs
index d09bcfd..e596bfc 100644
--- a/src/Lucene.Net.Expressions/ExpressionSortField.cs
+++ b/src/Lucene.Net.Expressions/ExpressionSortField.cs
@@ -21,10 +21,7 @@ namespace Lucene.Net.Expressions
      */
 
     /// <summary>
-    /// A
-    /// <see cref="Lucene.Net.Search.SortField">Lucene.Net.Search.SortField
-    /// 	</see>
-    /// which sorts documents by the evaluated value of an expression for each document
+    /// A <see cref="Lucene.Net.Search.SortField"/> which sorts documents by the evaluated
value of an expression for each document
     /// </summary>
     internal class ExpressionSortField : SortField
 	{

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/ExpressionValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/ExpressionValueSource.cs b/src/Lucene.Net.Expressions/ExpressionValueSource.cs
index 254ec77..897b5bc 100644
--- a/src/Lucene.Net.Expressions/ExpressionValueSource.cs
+++ b/src/Lucene.Net.Expressions/ExpressionValueSource.cs
@@ -26,14 +26,8 @@ namespace Lucene.Net.Expressions
      */
 
     /// <summary>
-    /// A
-    /// <see cref="Lucene.Net.Queries.Function.ValueSource">Lucene.Net.Queries.Function.ValueSource
-    /// 	</see>
-    /// which evaluates a
-    /// <see cref="Expression">Expression</see>
-    /// given the context of an
-    /// <see cref="Bindings">Bindings</see>
-    /// .
+    /// A <see cref="Lucene.Net.Queries.Function.ValueSource"/> which evaluates a
+    /// <see cref="Expression"/> given the context of an <see cref="Bindings"/>.
     /// </summary>
     internal sealed class ExpressionValueSource : ValueSource
 	{

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/JS/JavascriptCompiler.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/JS/JavascriptCompiler.cs b/src/Lucene.Net.Expressions/JS/JavascriptCompiler.cs
index 7706baa..550d756 100644
--- a/src/Lucene.Net.Expressions/JS/JavascriptCompiler.cs
+++ b/src/Lucene.Net.Expressions/JS/JavascriptCompiler.cs
@@ -38,38 +38,29 @@ namespace Lucene.Net.Expressions.JS
     /// <summary>An expression compiler for javascript expressions.</summary>
     /// <remarks>
     /// An expression compiler for javascript expressions.
-    /// <p/>
+    /// <para/>
     /// Example:
-    /// <pre class="prettyprint">
-    /// Expression foo = JavascriptCompiler.compile("((0.3*popularity)/10.0)+(0.7*score)");
-    /// </pre>
-    /// <p/>
-    /// See the
-    /// <see cref="Lucene.Net.Expressions.JS">package documentation</see>
-    /// for
+    /// <code>
+    /// Expression foo = JavascriptCompiler.Compile("((0.3*popularity)/10.0)+(0.7*score)");
+    /// </code>
+    /// <para/>
+    /// See the <see cref="Lucene.Net.Expressions.JS">package documentation</see>
for
     /// the supported syntax and default functions.
-    /// <p>
-    /// You can compile with an alternate set of functions via
-    /// <see Compile(string, System.Collections.Generic.IDictionary&lt;K, V&gt>
-    ///     <cref xml:space="preserve">Compile(string, System.Collections.Generic.IDictionary{K,
V})
-    /// 	</cref>
-    ///    
-    /// 	</see>
-    /// .
+    /// <para>
+    /// You can compile with an alternate set of functions via <see cref="Compile(string,
IDictionary{string, MethodInfo})"/>.
     /// For example:
-    /// <pre class="prettyprint">
-    /// Map&lt;String,Method&gt; functions = new HashMap&lt;String,Method&gt;();
+    /// <code>
+    /// IDictionary&lt;string, MethodInfo&gt; functions = new Dictionary&lt;string,
MethodInfo&gt;();
     /// // add all the default functions
-    /// functions.putAll(JavascriptCompiler.DEFAULT_FUNCTIONS);
-    /// // add cbrt()
-    /// functions.put("cbrt", Math.class.getMethod("cbrt", double.class));
+    /// functions.PutAll(JavascriptCompiler.DEFAULT_FUNCTIONS);
+    /// // add sqrt()
+    /// functions.Put("sqrt", (typeof(Math)).GetMethod("Sqrt", new Type[] { typeof(double)
}));
     /// // call compile with customized function map
-    /// Expression foo = JavascriptCompiler.compile("cbrt(score)+ln(popularity)",
-    /// functions,
-    /// getClass().getClassLoader());
-    /// </pre></p>
+    /// Expression foo = JavascriptCompiler.Compile("sqrt(score)+ln(popularity)", functions);
+    /// </code>
+    /// </para>
+    /// @lucene.experimental
     /// </remarks>
-    /// <lucene.experimental></lucene.experimental>
     public class JavascriptCompiler
     {
 
@@ -110,10 +101,8 @@ namespace Lucene.Net.Expressions.JS
         /// <summary>The default set of functions available to expressions.</summary>
         /// <remarks>
         /// The default set of functions available to expressions.
-        /// <p>
-        /// See the
-        /// <see cref="Lucene.Net.Expressions.JS">package documentation</see>
-        /// for a list.
+        /// <para/>
+        /// See the <see cref="Lucene.Net.Expressions.JS">package documentation</see>
for a list.
         /// </remarks>
         public static readonly IDictionary<string, MethodInfo> DEFAULT_FUNCTIONS;
 
@@ -126,10 +115,9 @@ namespace Lucene.Net.Expressions.JS
         // This maximum length is theoretically 65535 bytes, but as its CESU-8 encoded we
dont know how large it is in bytes, so be safe
         // rcmuir: "If your ranking function is that large you need to check yourself into
a mental institution!"
         /// <summary>Compiles the given expression.</summary>
-        /// <remarks>Compiles the given expression.</remarks>
         /// <param name="sourceText">The expression to compile</param>
         /// <returns>A new compiled expression</returns>
-
+        /// <exception cref="ParseException">on failure to compile</exception>
         public static Expression Compile(string sourceText)
         {
             return new JavascriptCompiler(sourceText).CompileExpression();
@@ -138,28 +126,14 @@ namespace Lucene.Net.Expressions.JS
         /// <summary>Compiles the given expression with the supplied custom functions.</summary>
         /// <remarks>
         /// Compiles the given expression with the supplied custom functions.
-        /// <p>
-        /// Functions must be
-        /// <code>public static</code>
-        /// , return
-        /// <code>double</code>
-        /// and
-        /// can take from zero to 256
-        /// <code>double</code>
-        /// parameters.
+        /// <para/>
+        /// Functions must be <c>public static</c>, return <see cref="double"/>
and
+        /// can take from zero to 256 <see cref="double"/> parameters.
         /// </remarks>
         /// <param name="sourceText">The expression to compile</param>
-        /// <param name="functions">map of String names to functions</param>
-        /// <param name="parent">
-        /// a
-        /// <code>ClassLoader</code>
-        /// that should be used as the parent of the loaded class.
-        /// It must contain all classes referred to by the given
-        /// <code>functions</code>
-        /// .
-        /// </param>
+        /// <param name="functions">map of <see cref="string"/> names to functions</param>
         /// <returns>A new compiled expression</returns>
-
+        /// <exception cref="ParseException">on failure to compile</exception>
         public static Expression Compile(string sourceText, IDictionary<string, MethodInfo>
functions)
         {
             foreach (MethodInfo m in functions.Values)
@@ -169,12 +143,11 @@ namespace Lucene.Net.Expressions.JS
             return new JavascriptCompiler(sourceText, functions).CompileExpression();
         }
 
-        /// <summary>This method is unused, it is just here to make sure that the function
signatures don't change.
-        /// 	</summary>
+        /// <summary>This method is unused, it is just here to make sure that the function
signatures don't change.</summary>
         /// <remarks>
         /// This method is unused, it is just here to make sure that the function signatures
don't change.
         /// If this method fails to compile, you also have to change the byte code generator
to correctly
-        /// use the FunctionValues class.
+        /// use the <see cref="FunctionValues"/> class.
         /// </remarks>
         private static void UnusedTestCompile()
         {
@@ -183,7 +156,6 @@ namespace Lucene.Net.Expressions.JS
         }
 
         /// <summary>Constructs a compiler for expressions.</summary>
-
         /// <param name="sourceText">The expression to compile</param>
         private JavascriptCompiler(string sourceText)
             : this(sourceText, DEFAULT_FUNCTIONS)
@@ -204,7 +176,7 @@ namespace Lucene.Net.Expressions.JS
 
         /// <summary>Compiles the given expression with the specified parent classloader</summary>
         /// <returns>A new compiled expression</returns>
-
+        /// <exception cref="ParseException">on failure to compile</exception>
         private Expression CompileExpression()
         {
             try

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/ScoreFunctionValues.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/ScoreFunctionValues.cs b/src/Lucene.Net.Expressions/ScoreFunctionValues.cs
index 331bebb..0dfd838 100644
--- a/src/Lucene.Net.Expressions/ScoreFunctionValues.cs
+++ b/src/Lucene.Net.Expressions/ScoreFunctionValues.cs
@@ -25,9 +25,7 @@ namespace Lucene.Net.Expressions
 
     /// <summary>
     /// A utility class to allow expressions to access the score as a
-    /// <see cref="Lucene.Net.Queries.Function.FunctionValues">Lucene.Net.Queries.Function.FunctionValues
-    /// 	</see>
-    /// .
+    /// <see cref="Lucene.Net.Queries.Function.FunctionValues"/>.
     /// </summary>
     internal class ScoreFunctionValues : DoubleDocValues
     {

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/ScoreValueSource.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/ScoreValueSource.cs b/src/Lucene.Net.Expressions/ScoreValueSource.cs
index 2b06093..f825663 100644
--- a/src/Lucene.Net.Expressions/ScoreValueSource.cs
+++ b/src/Lucene.Net.Expressions/ScoreValueSource.cs
@@ -24,22 +24,15 @@ namespace Lucene.Net.Expressions
      */
 
     /// <summary>
-    /// A
-    /// <see cref="Lucene.Net.Queries.Function.ValueSource">Lucene.Net.Queries.Function.ValueSource
-    /// 	</see>
-    /// which uses the
-    /// <see cref="Lucene.Net.Search.Scorer">Lucene.Net.Search.Scorer</see>
-    /// passed through
-    /// the context map by
-    /// <see cref="ExpressionComparer">ExpressionComparer</see>
-    /// .
+    /// A <see cref="Lucene.Net.Queries.Function.ValueSource"/> which uses the
+    /// <see cref="Lucene.Net.Search.Scorer"/> passed through
+    /// the context map by <see cref="ExpressionComparer"/>.
     /// </summary>
     internal class ScoreValueSource : ValueSource
 	{
 	    /// <summary>
-		/// <code>context</code> must contain a key "scorer" which is a
-		/// <see cref="Lucene.Net.Search.Scorer">Lucene.Net.Search.Scorer</see>
-		/// .
+		/// <paramref name="context"/> must contain a key "scorer" which is a
+		/// <see cref="Lucene.Net.Search.Scorer"/>.
 		/// </summary>
 		/// <exception cref="System.IO.IOException"></exception>
 		public override FunctionValues GetValues(IDictionary context, AtomicReaderContext

http://git-wip-us.apache.org/repos/asf/lucenenet/blob/8ade0b43/src/Lucene.Net.Expressions/SimpleBindings.cs
----------------------------------------------------------------------
diff --git a/src/Lucene.Net.Expressions/SimpleBindings.cs b/src/Lucene.Net.Expressions/SimpleBindings.cs
index af06d6f..b1f65f0 100644
--- a/src/Lucene.Net.Expressions/SimpleBindings.cs
+++ b/src/Lucene.Net.Expressions/SimpleBindings.cs
@@ -25,27 +25,23 @@ namespace Lucene.Net.Expressions
 
     /// <summary>
     /// Simple class that binds expression variable names to
-    /// <see cref="Lucene.Net.Search.SortField">Lucene.Net.Search.SortField
-    /// 	</see>
-    /// s
-    /// or other
-    /// <see cref="Expression">Expression</see>
-    /// s.
-    /// <p>
+    /// <see cref="Lucene.Net.Search.SortField"/>s or other
+    /// <see cref="Expression"/>s.
+    /// <para/>
     /// Example usage:
-    /// <pre class="prettyprint">
+    /// <code>
     /// SimpleBindings bindings = new SimpleBindings();
     /// // document's text relevance score
-    /// bindings.add(new SortField("_score", SortField.Type.SCORE));
+    /// bindings.Add(new SortField("_score", SortFieldType.SCORE));
     /// // integer NumericDocValues field (or from FieldCache)
-    /// bindings.add(new SortField("popularity", SortField.Type.INT));
+    /// bindings.Add(new SortField("popularity", SortFieldType.INT));
     /// // another expression
-    /// bindings.add("recency", myRecencyExpression);
+    /// bindings.Add("recency", myRecencyExpression);
     /// // create a sort field in reverse order
-    /// Sort sort = new Sort(expr.getSortField(bindings, true));
-    /// </pre>
+    /// Sort sort = new Sort(expr.GetSortField(bindings, true));
+    /// </code>
+    /// @lucene.experimental
     /// </summary>
-    /// <lucene.experimental></lucene.experimental>
     public sealed class SimpleBindings : Bindings
     {
         internal readonly IDictionary<string, object> map = new Dictionary<string,
object>();
@@ -55,10 +51,10 @@ namespace Lucene.Net.Expressions
         /// </summary>
         public SimpleBindings() { }
 
-        /// <summary>Adds a SortField to the bindings.</summary>
+        /// <summary>Adds a <see cref="SortField"/> to the bindings.</summary>
         /// <remarks>
-        /// Adds a SortField to the bindings.
-        /// <p>
+        /// Adds a <see cref="SortField"/> to the bindings.
+        /// <para/>
         /// This can be used to reference a DocValuesField, a field from
         /// FieldCache, the document's score, etc.
         /// </remarks>
@@ -67,10 +63,10 @@ namespace Lucene.Net.Expressions
             map[sortField.Field] = sortField;
         }
 
-        /// <summary>Adds an Expression to the bindings.</summary>
+        /// <summary>Adds an <see cref="Expression"/> to the bindings.</summary>
         /// <remarks>
-        /// Adds an Expression to the bindings.
-        /// <p>
+        /// Adds an <see cref="Expression"/> to the bindings.
+        /// <para/>
         /// This can be used to reference expressions from other expressions.
         /// </remarks>
         public void Add(string name, Expression expression)
@@ -126,8 +122,7 @@ namespace Lucene.Net.Expressions
             }
         }
 
-        /// <summary>Traverses the graph of bindings, checking there are no cycles
or missing references
-        /// 	</summary>
+        /// <summary>Traverses the graph of bindings, checking there are no cycles
or missing references</summary>
         /// <exception cref="System.ArgumentException">if the bindings is inconsistent</exception>
         public void Validate()
         {


Mime
View raw message