Merge pull request #698 from argilo/fix-encodepolar-docs

Fix encodepolar documentation
gnuradio · Dec 1, 2023 · bc0e0f8 · bc0e0f8
2 parents d84c49b + 1ccb121
commit bc0e0f8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/docs/kernels.dox b/docs/kernels.dox
@@ -127,7 +127,7 @@
 \li \subpage volk_8ic_s32f_deinterleave_real_32f
 \li \subpage volk_8ic_x2_s32f_multiply_conjugate_32fc
 \li \subpage volk_8i_s32f_convert_32f
-\li \subpage volk_8u_x3_encodepolar_8u
+\li \subpage volk_8u_x3_encodepolar_8u_x2
 \li \subpage volk_8u_x4_conv_k7_r2_8u
 
 */
diff --git a/kernels/volk/volk_8u_x3_encodepolar_8u_x2.h b/kernels/volk/volk_8u_x3_encodepolar_8u_x2.h
@@ -8,15 +8,15 @@
  */
 
 /*!
- * \page volk_8u_x3_encodepolar_8u
+ * \page volk_8u_x3_encodepolar_8u_x2
  *
  * \b Overview
  *
  * encode given data for POLAR code
  *
  * <b>Dispatcher Prototype</b>
  * \code
- * void volk_8u_x3_encodepolar_8u(unsigned char* frame, const unsigned char*
+ * void volk_8u_x3_encodepolar_8u_x2(unsigned char* frame, const unsigned char*
  * frozen_bit_mask, const unsigned char* frozen_bits, const unsigned char* info_bits,
  * unsigned int frame_size, unsigned int info_bit_size) \endcode
  *
@@ -51,8 +51,8 @@
  *
  * unsigned char* info_bits = get_info_bits_to_encode(num_info_bits);
  *
- * volk_8u_x3_encodepolar_8u_x2_generic(frame, temp, frozen_bit_mask, frozen_bits,
- * info_bits, frame_size);
+ * volk_8u_x3_encodepolar_8u_x2(
+ *     frame, temp, frozen_bit_mask, frozen_bits, info_bits, frame_size);
  *
  * volk_free(frozen_bit_mask);
  * volk_free(frozen_bits);