[batchnorm] improve docs for return values
authorPaul Brossier <piem@piem.org>
Tue, 29 Jan 2019 00:08:00 +0000 (01:08 +0100)
committerPaul Brossier <piem@piem.org>
Wed, 29 Dec 2021 16:52:00 +0000 (11:52 -0500)
src/ai/batchnorm.h

index 8d389a5..b299fed 100644 (file)
@@ -56,6 +56,8 @@ aubio_batchnorm_t *new_aubio_batchnorm(void);
   \param input  input tensor
   \param shape  output shape
 
+  \return 0 on success, non-zero otherwise
+
   This function determines the number of output channels required and allocate
   the vectors of weights. The ouptut shape of this layer is identical to the
   input shape.
@@ -159,8 +161,6 @@ uint_t aubio_batchnorm_set_moving_variance(aubio_batchnorm_t *t,
   \param input_tensor  input tensor
   \param activations   output tensor
 
-  \return   0 on success, non-zero otherwise.
-
 */
 void aubio_batchnorm_do(aubio_batchnorm_t *t, aubio_tensor_t *input_tensor,
         aubio_tensor_t *activations);