diff lsp.h @ 12181:0885e7a93ed4 libavcodec

Fix Doxygen @param command attribute syntax. The [in] and [out] attributes have to be appended to the @param command.
author diego
date Sat, 17 Jul 2010 10:43:42 +0000
parents 4f06422196ee
children 2dd67ed2f947
line wrap: on
line diff
--- a/lsp.h	Fri Jul 16 21:35:30 2010 +0000
+++ b/lsp.h	Sat Jul 17 10:43:42 2010 +0000
@@ -31,7 +31,7 @@
 
 /**
  * \brief ensure a minimum distance between LSFs
- * \param lsfq [in/out] LSF to check and adjust
+ * \param[in,out] lsfq LSF to check and adjust
  * \param lsfq_min_distance minimum distance between LSFs
  * \param lsfq_min minimum allowed LSF value
  * \param lsfq_max maximum allowed LSF value
@@ -54,7 +54,7 @@
 
 /**
  * \brief Convert LSF to LSP
- * \param lsp [out] LSP coefficients (-0x8000 <= (0.15) < 0x8000)
+ * \param[out] lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000)
  * \param lsf normalized LSF coefficients (0 <= (2.13) < 0x2000 * PI)
  * \param lp_order LP filter order
  *
@@ -64,7 +64,7 @@
 
 /**
  * \brief LSP to LP conversion (3.2.6 of G.729)
- * \param lp [out] decoded LP coefficients (-0x8000 <= (3.12) < 0x8000)
+ * \param[out] lp decoded LP coefficients (-0x8000 <= (3.12) < 0x8000)
  * \param lsp LSP coefficients (-0x8000 <= (0.15) < 0x8000)
  * \param lp_half_order LP filter order, divided by 2
  */
@@ -72,8 +72,8 @@
 
 /**
  * \brief Interpolate LSP for the first subframe and convert LSP -> LP for both subframes (3.2.5 and 3.2.6 of G.729)
- * \param lp_1st [out] decoded LP coefficients for first subframe (-0x8000 <= (3.12) < 0x8000)
- * \param lp_2nd [out] decoded LP coefficients for second subframe (-0x8000 <= (3.12) < 0x8000)
+ * \param[out] lp_1st decoded LP coefficients for first subframe  (-0x8000 <= (3.12) < 0x8000)
+ * \param[out] lp_2nd decoded LP coefficients for second subframe (-0x8000 <= (3.12) < 0x8000)
  * \param lsp_2nd LSP coefficients of the second subframe (-0x8000 <= (0.15) < 0x8000)
  * \param lsp_prev LSP coefficients from the second subframe of the previous frame (-0x8000 <= (0.15) < 0x8000)
  * \param lp_order LP filter order
@@ -111,7 +111,7 @@
  * We only need to calculate the 6 first elements of the polynomial.
  *
  * @param lsp line spectral pairs in cosine domain
- * @param f [out] polynomial input/output as a vector
+ * @param[out] f polynomial input/output as a vector
  *
  * TIA/EIA/IS-733 2.4.3.3.5-1/2
  */