Fix documentation

tom-englert · Feb 10, 2016 · f6352c3 · f6352c3
1 parent da53cdb
commit f6352c3
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 10 deletions.
diff --git a/TomsToolbox.Wpf/Converters/CoordinatesToPointConverter.cs b/TomsToolbox.Wpf/Converters/CoordinatesToPointConverter.cs
@@ -50,8 +50,11 @@ protected override object ConvertBack(object value, Type targetType, object para
         }
 
         /// <summary>
-        /// Converts WGS-84 coordinates (<see cref="Coordinates"/> ) into normalized logical XY coordinates (<see cref="Point"/>) in the range 0..1 and back.
+        /// Converts WGS-84 coordinates (<see cref="Coordinates" /> ) into normalized logical XY coordinates (<see cref="Point" />) in the range 0..1 and back.
         /// </summary>
+        /// <param name="value">The <see cref="Coordinates" /> or <see cref="Point" /> value.</param>
+        /// <returns>The <see cref="Coordinates" /> or <see cref="Point" /> value.</returns>
+        /// <exception cref="System.InvalidOperationException">Value is neither a Point nor a Coordinates structure.</exception>
         public static object Convert(object value)
         {
             if (value is Point)
@@ -64,7 +67,7 @@ public static object Convert(object value)
                 return (Point)(Coordinates)value;
             }
 
-            throw new InvalidOperationException("Value us neither of type Point nor of type Coordinates");
+            throw new InvalidOperationException("Value is neither a Point nor a Coordinates structure");
         }
     }
 }
diff --git a/TomsToolbox.Wpf/Converters/ValueConverterExtensions.cs b/TomsToolbox.Wpf/Converters/ValueConverterExtensions.cs
@@ -14,13 +14,14 @@ public static class ValueConverterExtensions
         /// The error number shown in the output.
         /// </summary>
         [SuppressMessage("Microsoft.Usage", "CA2211:NonConstantFieldsShouldNotBeVisible")]
-        public static int ConverterErrorNumber = 9000;
-
-        /// <summary>
-        /// Traces an error for the specified converter.
-        /// </summary>
-        /// <param name="converter">The converter.</param>
-        /// <param name="message">The message.</param>
+        public static int ConverterErrorNumber = 9000;
+
+        /// <summary>
+        /// Traces an error for the specified converter.
+        /// </summary>
+        /// <param name="converter">The converter.</param>
+        /// <param name="message">The message.</param>
+        /// <param name="methodName">Name of the calling method.</param>
         public static void TraceError(this IValueConverter converter, string message, string methodName)
         {
             Contract.Requires(converter != null);
@@ -34,7 +35,8 @@ public static void TraceError(this IValueConverter converter, string message, st
         /// Traces an error for the specified converter.
         /// </summary>
         /// <param name="converter">The converter.</param>
-        /// <param name="message">The message.</param>
+        /// <param name="message">The message.</param>
+        /// <param name="methodName">Name of the calling method.</param>
         public static void TraceError(this IMultiValueConverter converter, string message, string methodName)
         {
             Contract.Requires(converter != null);