Skip to content

Commit cef6ec0

Browse files
sharwellOceania2018
sharwell
authored and
Oceania2018
committed
Fix CS1572 (XML comment has a param tag, but there is no parameter by that name)
1 parent 02d9023 commit cef6ec0

File tree

15 files changed

+16
-36
lines changed

15 files changed

+16
-36
lines changed

‎Directory.Build.props

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@
1717
Suppress warnings for currently-invalid documentation comments.
1818
1919
CS1570: XML comment has badly formed XML
20-
CS1572: XML comment has a param tag, but there is no parameter by that name
2120
-->
22-
<NoWarn>$(NoWarn),1570,1572</NoWarn>
21+
<NoWarn>$(NoWarn),1570</NoWarn>
2322
</PropertyGroup>
2423

2524
</Project>

‎src/TensorFlowNET.Core/APIs/tf.init.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public IInitializer random_normal_initializer(float mean = 0.0f,
6868
/// </summary>
6969
/// <param name="factor"></param>
7070
/// <param name="mode"></param>
71-
/// <param name="distribution"></param>
71+
/// <param name="uniform"></param>
7272
/// <param name="seed"></param>
7373
/// <param name="dtype"></param>
7474
/// <returns></returns>

‎src/TensorFlowNET.Core/Eager/c_api.eager.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public static extern void TFE_RegisterGradientFunction(gradient_function_callbac
1818
/// <param name="op_name"></param>
1919
/// <param name="op_inputs"></param>
2020
/// <param name="op_outputs"></param>
21-
/// <param name="num_attrs"></param>
21+
/// <param name="attrs_string"></param>
2222
/// <param name="output_grads">previous node ouput</param>
2323
/// <param name="skip_input_indices"></param>
2424
/// <returns></returns>
@@ -355,7 +355,7 @@ public delegate void delete_backward_function_callback(string op_name,
355355
/// TFE_ExecutorWaitForAllPendingNodes before calling this API if you want to
356356
/// make sure all nodes are finished.
357357
/// </summary>
358-
/// <param name="e">TFE_Executor*</param>
358+
/// <param name="executor">TFE_Executor*</param>
359359
[DllImport(TensorFlowLibName)]
360360
public static extern void TFE_DeleteExecutor(IntPtr executor);
361361

‎src/TensorFlowNET.Core/Gradients/nn_grad.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class nn_grad
3030
/// Return the gradients for the 2 inputs of bias_op.
3131
/// </summary>
3232
/// <param name="op"></param>
33-
/// <param name="grad"></param>
33+
/// <param name="grads"></param>
3434
/// <returns></returns>
3535
[RegisterGradient("BiasAdd")]
3636
public static Tensor[] _BiasAddGrad(Operation op, Tensor[] grads)
@@ -78,8 +78,7 @@ public static Tensor[] _SoftmaxGrad(Operation op, Tensor[] grads)
7878
/// Gradient function for SoftmaxCrossEntropyWithLogits.
7979
/// </summary>
8080
/// <param name="op"></param>
81-
/// <param name="grad_loss"></param>
82-
/// <param name="grad_grad"></param>
81+
/// <param name="grads"></param>
8382
/// <returns></returns>
8483
[RegisterGradient("SoftmaxCrossEntropyWithLogits")]
8584
public static Tensor[] _SoftmaxCrossEntropyWithLogitsGrad(Operation op, Tensor[] grads)

‎src/TensorFlowNET.Core/Interfaces/ITensorFlowObject.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ public interface ITensorFlowObject : IDisposable
2323
/// <summary>
2424
/// Called when the instance is created.
2525
/// </summary>
26-
/// <param name="args"></param>
2726
void __init__();
2827

2928
void __enter__();

‎src/TensorFlowNET.Core/Operations/NnOps/gen_nn_ops.cs

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -161,15 +161,7 @@ public static Tensor elu(Tensor features, string name = "Elu")
161161
/// <summary>
162162
/// Gradient for batch normalization.
163163
/// </summary>
164-
/// <param name="y_backprop"></param>
165-
/// <param name="x"></param>
166-
/// <param name="scale"></param>
167-
/// <param name="reserve_space_1"></param>
168-
/// <param name="reserve_space_2"></param>
169-
/// <param name="epsilon"></param>
170-
/// <param name="data_format"></param>
171-
/// <param name="is_training"></param>
172-
/// <param name="name"></param>
164+
/// <param name="params"></param>
173165
/// <returns></returns>
174166
public static Tensor[] fused_batch_norm_grad(FusedBatchNormParams @params)
175167
{

‎src/TensorFlowNET.Core/Operations/control_flow_ops.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -637,7 +637,7 @@ public static Tensor ZerosLikeOutsideLoop(Operation op, int index)
637637
/// <param name="cond"></param>
638638
/// <param name="body"></param>
639639
/// <param name="loop_vars"></param>
640-
/// <param name="i"></param>
640+
/// <param name="shape_invariants"></param>
641641
public static TItem while_loop<TItem>(Func<TItem, Tensor> cond, Func<TItem, TItem> body, TItem loop_vars,
642642
TensorShape[] shape_invariants = null,
643643
int parallel_iterations = 10,

‎src/TensorFlowNET.Core/Operations/random_ops.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ public static Tensor multinomial(Tensor logits, int num_samples, int? seed = nul
158158
/// </summary>
159159
/// <param name="logits"></param>
160160
/// <param name="num_samples"></param>
161-
/// <param name="output_dtype"></param>
161+
/// <param name="dtype"></param>
162162
/// <param name="seed"></param>
163163
/// <returns></returns>
164164
private static Tensor multinomial_categorical_impl(Tensor logits, int num_samples, TF_DataType dtype = TF_DataType.DtInvalid,

‎src/TensorFlowNET.Core/Operations/resource_variable_ops.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ public static Tensor variable_handle_from_shape_and_dtype(TensorShape shape, TF_
151151
/// Sets the shape inference result HandleData on tensor.
152152
/// </summary>
153153
/// <param name="handle"></param>
154-
/// <param name="full_handle_data"></param>
154+
/// <param name="handle_data"></param>
155155
/// <param name="graph_mode"></param>
156156
private static void _set_handle_shapes_and_types(Tensor handle, HandleData handle_data, bool graph_mode)
157157
{

‎src/TensorFlowNET.Core/Tensors/c_api.tensor.cs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,6 @@ public partial class c_api
103103
/// <param name="num_dims"></param>
104104
/// <param name="data"></param>
105105
/// <param name="len">num_bytes, ex: 6 * sizeof(float)</param>
106-
/// <param name="deallocator"></param>
107-
/// <param name="deallocator_arg"></param>
108106
[MethodImpl(MethodImplOptions.AggressiveInlining)]
109107
public static unsafe IntPtr TF_NewTensor(TF_DataType dataType, long[] dims, int num_dims, IntPtr data, ulong len)
110108
{
@@ -118,8 +116,6 @@ public static unsafe IntPtr TF_NewTensor(TF_DataType dataType, long[] dims, int
118116
/// <param name="num_dims"></param>
119117
/// <param name="data"></param>
120118
/// <param name="len">num_bytes, ex: 6 * sizeof(float)</param>
121-
/// <param name="deallocator"></param>
122-
/// <param name="deallocator_arg"></param>
123119
[MethodImpl(MethodImplOptions.AggressiveInlining)]
124120
public static unsafe IntPtr TF_NewTensor(TF_DataType dataType, long[] dims, int num_dims, void* data, ulong len)
125121
{

‎src/TensorFlowNET.Core/Tensors/constant_op.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ public class constant_op
3535
/// <param name="dtype">The type of the elements of the resulting tensor.</param>
3636
/// <param name="shape">Optional dimensions of resulting tensor.</param>
3737
/// <param name="name">Optional name for the tensor.</param>
38-
/// <param name="verify_shape">Boolean that enables verification of a shape of values.</param>
3938
/// <returns></returns>
4039
public static Tensor constant(object value, TF_DataType dtype = TF_DataType.DtInvalid, int[] shape = null, string name = "Const")
4140
{
4241
return _constant_impl(value, dtype, shape, name, verify_shape: false, allow_broadcast: true);
4342
}
4443

44+
/// <param name="verify_shape">Boolean that enables verification of a shape of values.</param>
4545
public static Tensor _constant_impl(object value,
4646
TF_DataType dtype,
4747
TensorShape shape,

‎src/TensorFlowNET.Core/Training/GradientDescentOptimizer.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ namespace Tensorflow.Train
2121
/// </summary>
2222
public class GradientDescentOptimizer : Optimizer
2323
{
24+
private bool _useTensor;
25+
2426
/// <summary>
2527
/// Construct a new gradient descent optimizer.
2628
/// </summary>
@@ -35,7 +37,6 @@ public class GradientDescentOptimizer : Optimizer
3537
/// for changing these values across different invocations of optimizer
3638
/// functions.
3739
/// </remarks>
38-
private bool _useTensor;
3940
public GradientDescentOptimizer(float learning_rate, bool use_locking = false, string name = "GradientDescent")
4041
: base(learning_rate, use_locking, name)
4142
{

‎src/TensorFlowNET.Core/Util/nest.py.cs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -486,13 +486,7 @@ public static object pack_sequence_as(object structure, IEnumerable<object> flat
486486
/// and the return value will contain the results in the same structure.
487487
/// </summary>
488488
/// <param name="func"> A callable that accepts as many arguments as there are structures.</param>
489-
/// <param name="structures">one or many IEnumerable of object</param>
490-
/// <param name="check_types">If set to
491-
/// `True` (default) the types of iterables within the structures have to be
492-
/// same (e.g. `map_structure(func, [1], (1,))` raises a `TypeError`
493-
/// exception). To allow this set this argument to `False`.
494-
/// Note that namedtuples with identical name and fields are always
495-
/// considered to have the same shallow structure.</param>
489+
/// <param name="structure">one or many IEnumerable of object</param>
496490
/// <returns>
497491
/// A new structure with the same arity as `structure`, whose values correspond
498492
/// to `func(x[0], x[1], ...)` where `x[i]` is a value in the corresponding

‎src/TensorFlowNET.Core/Variables/gen_state_ops.py.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public static Tensor variable_v2(int[] shape, TF_DataType dtype, string name = n
5151
/// <summary>
5252
/// Update 'ref' by assigning 'value' to it
5353
/// </summary>
54-
/// <param name="REF"></param>
54+
/// <param name="ref"></param>
5555
/// <param name="value"></param>
5656
/// <param name="validate_shape"></param>
5757
/// <param name="use_locking"></param>

‎src/TensorFlowNET.Core/ops.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ public static void _colocate_with_for_gradient(Operation op, string gradient_uid
313313
/// <summary>
314314
/// Uses the default session to evaluate one or more tensors.
315315
/// </summary>
316-
/// <param name="tensors">A single Tensor, or a list of Tensor objects.</param>
316+
/// <param name="tensor">A single Tensor, or a list of Tensor objects.</param>
317317
/// <param name="feed_dict">
318318
/// A dictionary that maps Tensor objects (or tensor names) to lists,
319319
/// numpy ndarrays, TensorProtos, or strings.

0 commit comments

Comments
 (0)