Fix xml-docs build warnings

vmuriart · vmuriart · commit 54841da1d2a2 · 2017-02-13T10:35:58.000-07:00
diff --git a/src/runtime/constructorbinding.cs b/src/runtime/constructorbinding.cs
@@ -82,14 +82,11 @@ public static IntPtr tp_descr_get(IntPtr op, IntPtr instance, IntPtr owner)
         /// <summary>
         /// Implement explicit overload selection using subscript syntax ([]).
         /// </summary>
-        /// <summary>
+        /// <remarks>
         /// ConstructorBinding.GetItem(PyObject *o, PyObject *key)
         /// Return element of o corresponding to the object key or NULL on failure.
         /// This is the equivalent of the Python expression o[key].
-        /// </summary>
-        /// <param name="tp"></param>
-        /// <param name="idx"></param>
-        /// <returns></returns>
+        /// </remarks>
         public static IntPtr mp_subscript(IntPtr op, IntPtr key)
         {
             var self = (ConstructorBinding)GetManagedObject(op);
@@ -183,7 +180,7 @@ public BoundContructor(Type type, IntPtr pyTypeHndl, ConstructorBinder ctorBinde
         /// <summary>
         /// BoundContructor.__call__(PyObject *callable_object, PyObject *args, PyObject *kw)
         /// </summary>
-        /// <param name="ob"> PyObject *callable_object </param>
+        /// <param name="op"> PyObject *callable_object </param>
         /// <param name="args"> PyObject *args </param>
         /// <param name="kw"> PyObject *kw </param>
         /// <returns> A reference to a new instance of the class by invoking the selected ctor(). </returns>
diff --git a/src/runtime/exceptions.cs b/src/runtime/exceptions.cs
@@ -134,10 +134,10 @@ internal static void Shutdown()
         /// __getattr__ implementation, and thus dereferencing a NULL
         /// pointer.
         /// </summary>
-        /// <param name="e">A CLR exception</param>
         /// <param name="ob">The python object wrapping </param>
         internal static void SetArgsAndCause(IntPtr ob)
         {
+            // e: A CLR Exception
             Exception e = ExceptionClassObject.ToException(ob);
             if (e == null)
             {

Original file line number	Diff line number	Diff line change
`@@ -134,10 +134,10 @@ internal static void Shutdown()`
`134`	`134`	`/// __getattr__ implementation, and thus dereferencing a NULL`
`135`	`135`	`/// pointer.`
`136`	`136`	`/// </summary>`
`137`		`- /// <param name="e">A CLR exception</param>`
`138`	`137`	`/// <param name="ob">The python object wrapping </param>`
`139`	`138`	`internal static void SetArgsAndCause(IntPtr ob)`
`140`	`139`	`{`
	`140`	`+ // e: A CLR Exception`
`141`	`141`	`Exception e = ExceptionClassObject.ToException(ob);`
`142`	`142`	`if (e == null)`
`143`	`143`	`{`