GH-820: Fixing XML comments from last commit.

accord-net · Oct 11, 2017 · b09adaf · b09adaf
1 parent 77edbc3
commit b09adaf
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 10 deletions.
diff --git a/Sources/Accord.Math/Optimization/Constrained/Constraints/ConstraintExtensions.cs b/Sources/Accord.Math/Optimization/Constrained/Constraints/ConstraintExtensions.cs
@@ -31,18 +31,16 @@ public static class ConstraintExtensions
     {
 
         /// <summary>
-        ///   Gets how much the constraint is being violated.
+        /// Gets how much the constraint is being violated.
         /// </summary>
-        /// 
+        /// <param name="constraint">The constraint.</param>
         /// <param name="input">The function point.</param>
-        /// 
         /// <returns>
-        ///   How much the constraint is being violated at the given point. Positive
-        ///   value means the constraint is not being violated with the returned slack, 
-        ///   while a negative value means the constraint is being violated by the returned
-        ///   amount.
+        /// How much the constraint is being violated at the given point. Positive
+        /// value means the constraint is not being violated with the returned slack,
+        /// while a negative value means the constraint is being violated by the returned
+        /// amount.
         /// </returns>
-        /// 
         public static double GetViolation(this IConstraint constraint, double[] input)
         {
             double fx = constraint.Function(input);

diff --git a/Sources/Accord.Math/Optimization/Constrained/Constraints/IConstraint.cs b/Sources/Accord.Math/Optimization/Constrained/Constraints/IConstraint.cs
@@ -22,8 +22,11 @@
 
 namespace Accord.Math.Optimization
 {
-    using System;
-
+    using System;
+
+    /// <summary>
+    /// Defines an interface for an optimization constraint.
+    /// </summary>
     public interface IConstraint
     {
         /// <summary>