Fix CS1587 (XML comment is not placed on a valid language element)

Author: sharwell

Directory.Build.props

@@ -18,9 +18,8 @@
 
       CS1570: XML comment has badly formed XML
       CS1572: XML comment has a param tag, but there is no parameter by that name
-      CS1587: XML comment is not placed on a valid language element
     -->
-    <NoWarn>$(NoWarn),1570,1572,1587</NoWarn>
+    <NoWarn>$(NoWarn),1570,1572</NoWarn>
   </PropertyGroup>
 
 </Project>

src/TensorFlowNET.Core/Gradients/gradients_util.cs

@@ -47,13 +47,13 @@ public static Tensor[] _GradientsHelper(Tensor[] ys,
                 grad_ys = new Tensor[ys.Length];
 
             // Iterate over the collected ops.
-            /**
+            /*
              * grads: op => list of gradients received on each output endpoint of the
              * op.  The gradients for each endpoint are initially collected as a list.
              * When it is time to call the op's gradient function, for each endpoint we
              * aggregate the list of received gradients into a Add() Operation if there
              * is more than one.
-             **/
+             */
             var grads = new Dictionary<string, List<List<Tensor>>>();
             Operation[] reachable_to_ops = null;
             ControlFlowState loop_state = null;
@@ -70,14 +70,14 @@ public static Tensor[] _GradientsHelper(Tensor[] ys,
                     xs = ops.internal_convert_n_to_tensor_or_indexed_slices(xs, name: "x", as_ref: true);
                     grad_ys = _DefaultGradYs(grad_ys, ys, colocate_gradients_with_ops, gradient_uid);
 
-                    /** 
+                    /*
                      * The approach we take here is as follows: Create a list of all ops in the
                      * subgraph between the ys and xs.  Visit these ops in reverse order of ids
                      * to ensure that when we visit an op the gradients w.r.t its outputs have
                      * been collected.  Then aggregate these gradients if needed, call the op's
                      * gradient function, and add the generated gradients to the gradients for
                      * its input.
-                     **/
+                     */
 
                     // Initialize the pending count for ops in the connected subgraph from ys
                     // to the xs.

src/TensorFlowNET.Core/Graphs/c_api.graph.cs

@@ -178,7 +178,7 @@ public partial class c_api
         /// <summary>
         /// Add an operation in `graph_def` to be returned via the `return_opers` output
         /// parameter of TF_GraphImportGraphDef(). `oper_name` is copied and has no
-        // lifetime requirements.
+        /// lifetime requirements.
         /// </summary>
         /// <param name="opts">TF_ImportGraphDefOptions* opts</param>
         /// <param name="oper_name">const char*</param>

src/TensorFlowNET.Core/Operations/Distributions/distribution.py.cs

@@ -97,6 +97,7 @@ public TF_DataType dtype()
         }
 
 
+        /*
         /// <summary>
         /// Constructs the `Distribution'     
         /// **This is a private method for subclass use.**
@@ -117,7 +118,6 @@ public TF_DataType dtype()
         /// <param name = "name"> Name prefixed to Ops created by this class. Default: subclass name.</param>
         /// <returns> Two `Tensor` objects: `mean` and `variance`.</returns>
 
-        /*
         private Distribution (
                 TF_DataType dtype,
                 ReparameterizationType reparameterization_type,

test/TensorFlowNET.UnitTest/Utilities/PrivateType.cs

@@ -548,19 +548,19 @@ internal static void CheckParameterNotNull(object param, string parameterName, s
             }
         }
 
-        /// <summary>
-        /// The check parameter not null or empty.
-        /// </summary>
-        /// <param name="param">
-        /// The parameter.
-        /// </param>
-        /// <param name="parameterName">
-        /// The parameter name.
-        /// </param>
-        /// <param name="message">
-        /// The message.
-        /// </param>
-        /// <exception cref="ArgumentException"> Throws ArgumentException when parameter is null. </exception>
+        ///// <summary>
+        ///// The check parameter not null or empty.
+        ///// </summary>
+        ///// <param name="param">
+        ///// The parameter.
+        ///// </param>
+        ///// <param name="parameterName">
+        ///// The parameter name.
+        ///// </param>
+        ///// <param name="message">
+        ///// The message.
+        ///// </param>
+        ///// <exception cref="ArgumentException"> Throws ArgumentException when parameter is null. </exception>
         //internal static void CheckParameterNotNullOrEmpty(string param, string parameterName, string message)
         //{
         //    if (string.IsNullOrEmpty(param))