summaryrefslogtreecommitdiff
path: root/gr-vocoder/include/vocoder
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2013-04-04 11:50:35 -0400
committerTom Rondeau <trondeau@vt.edu>2013-04-04 12:37:40 -0400
commit8b1303bbb0bf72569a5149082796f50b6e8f9a5b (patch)
tree5809962a19338db21f28957535529552d12992a1 /gr-vocoder/include/vocoder
parent2930f1b4265b794599d814e9a3d68fd03bde010f (diff)
docs: fixes for merge conflicts and differences between master/next.
Diffstat (limited to 'gr-vocoder/include/vocoder')
-rw-r--r--gr-vocoder/include/vocoder/alaw_decode_bs.h2
-rw-r--r--gr-vocoder/include/vocoder/alaw_encode_sb.h2
-rw-r--r--gr-vocoder/include/vocoder/codec2_decode_ps.h2
-rw-r--r--gr-vocoder/include/vocoder/codec2_encode_sp.h2
-rw-r--r--gr-vocoder/include/vocoder/cvsd_decode_bs.h6
-rw-r--r--gr-vocoder/include/vocoder/cvsd_encode_sb.h6
-rw-r--r--gr-vocoder/include/vocoder/g721_decode_bs.h2
-rw-r--r--gr-vocoder/include/vocoder/g721_encode_sb.h2
-rw-r--r--gr-vocoder/include/vocoder/g723_24_decode_bs.h2
-rw-r--r--gr-vocoder/include/vocoder/g723_24_encode_sb.h2
-rw-r--r--gr-vocoder/include/vocoder/g723_40_decode_bs.h2
-rw-r--r--gr-vocoder/include/vocoder/g723_40_encode_sb.h2
-rw-r--r--gr-vocoder/include/vocoder/gsm_fr_decode_ps.h2
-rw-r--r--gr-vocoder/include/vocoder/gsm_fr_encode_sp.h2
-rw-r--r--gr-vocoder/include/vocoder/ulaw_decode_bs.h2
-rw-r--r--gr-vocoder/include/vocoder/ulaw_encode_sb.h2
16 files changed, 18 insertions, 22 deletions
diff --git a/gr-vocoder/include/vocoder/alaw_decode_bs.h b/gr-vocoder/include/vocoder/alaw_decode_bs.h
index 571794275b..9966512c2a 100644
--- a/gr-vocoder/include/vocoder/alaw_decode_bs.h
+++ b/gr-vocoder/include/vocoder/alaw_decode_bs.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs alaw audio decoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API alaw_decode_bs : virtual public gr_sync_block
{
diff --git a/gr-vocoder/include/vocoder/alaw_encode_sb.h b/gr-vocoder/include/vocoder/alaw_encode_sb.h
index 95ab4a12b2..e944a93455 100644
--- a/gr-vocoder/include/vocoder/alaw_encode_sb.h
+++ b/gr-vocoder/include/vocoder/alaw_encode_sb.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs g.711 alaw audio encoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API alaw_encode_sb : virtual public gr_sync_block
{
diff --git a/gr-vocoder/include/vocoder/codec2_decode_ps.h b/gr-vocoder/include/vocoder/codec2_decode_ps.h
index 31738fea16..9c0d1526b8 100644
--- a/gr-vocoder/include/vocoder/codec2_decode_ps.h
+++ b/gr-vocoder/include/vocoder/codec2_decode_ps.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief CODEC2 Vocoder Decoder
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API codec2_decode_ps : virtual public gr_sync_interpolator
{
diff --git a/gr-vocoder/include/vocoder/codec2_encode_sp.h b/gr-vocoder/include/vocoder/codec2_encode_sp.h
index 59ed100837..2960bee04b 100644
--- a/gr-vocoder/include/vocoder/codec2_encode_sp.h
+++ b/gr-vocoder/include/vocoder/codec2_encode_sp.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief CODEC2 Vocoder Encoder
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API codec2_encode_sp : virtual public gr_sync_decimator
{
diff --git a/gr-vocoder/include/vocoder/cvsd_decode_bs.h b/gr-vocoder/include/vocoder/cvsd_decode_bs.h
index b9fa8fc080..03dedffbbd 100644
--- a/gr-vocoder/include/vocoder/cvsd_decode_bs.h
+++ b/gr-vocoder/include/vocoder/cvsd_decode_bs.h
@@ -33,9 +33,9 @@ namespace gr {
* \brief This block performs CVSD audio decoding. Its design and
* implementation is modeled after the CVSD encoder/decoder
* specifications defined in the Bluetooth standard.
+ * \ingroup audio_blk
*
- * \ingroup vocoder_blk
- *
+ * \details
* CVSD is a method for encoding speech that seeks to reduce the
* bandwidth required for digital voice transmission. CVSD takes
* advantage of strong correlation between samples, quantizing the
@@ -94,8 +94,6 @@ namespace gr {
* The default values are modeled after the Bluetooth standard
* and should not be changed, except by an advanced user
*
- * \ingroup vocoder_blk
- *
* \param min_step Minimum step size used to update the internal reference.
* Default: "10"
* \param max_step Maximum step size used to update the internal reference.
diff --git a/gr-vocoder/include/vocoder/cvsd_encode_sb.h b/gr-vocoder/include/vocoder/cvsd_encode_sb.h
index 1fca494469..c12269562e 100644
--- a/gr-vocoder/include/vocoder/cvsd_encode_sb.h
+++ b/gr-vocoder/include/vocoder/cvsd_encode_sb.h
@@ -32,9 +32,9 @@ namespace gr {
* \brief This block performs CVSD audio encoding. Its design and
* implementation is modeled after the CVSD encoder/decoder
* specifications defined in the Bluetooth standard.
+ * \ingroup audio_blk
*
- * \ingroup vocoder_blk
- *
+ * \details
* CVSD is a method for encoding speech that seeks to reduce the
* bandwidth required for digital voice transmission. CVSD takes
* advantage of strong correlation between samples, quantizing the
@@ -95,8 +95,6 @@ namespace gr {
* The default values are modeled after the Bluetooth standard and
* should not be changed except by an advanced user
*
- * \ingroup vocoder_blk
- *
* \param min_step Minimum step size used to update the internal reference. Default: "10"
* \param max_step Maximum step size used to update the internal reference. Default: "1280"
* \param step_decay Decay factor applied to step size when there is not a run of J output 1s or 0s.
diff --git a/gr-vocoder/include/vocoder/g721_decode_bs.h b/gr-vocoder/include/vocoder/g721_decode_bs.h
index a836a1b63d..05459ccb3d 100644
--- a/gr-vocoder/include/vocoder/g721_decode_bs.h
+++ b/gr-vocoder/include/vocoder/g721_decode_bs.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs g721 audio decoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API g721_decode_bs : virtual public gr_sync_block
{
diff --git a/gr-vocoder/include/vocoder/g721_encode_sb.h b/gr-vocoder/include/vocoder/g721_encode_sb.h
index 60df4d5d8e..af03b855c3 100644
--- a/gr-vocoder/include/vocoder/g721_encode_sb.h
+++ b/gr-vocoder/include/vocoder/g721_encode_sb.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs g721 audio encoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API g721_encode_sb : virtual public gr_sync_block
{
diff --git a/gr-vocoder/include/vocoder/g723_24_decode_bs.h b/gr-vocoder/include/vocoder/g723_24_decode_bs.h
index f3422ed72a..e91354071d 100644
--- a/gr-vocoder/include/vocoder/g723_24_decode_bs.h
+++ b/gr-vocoder/include/vocoder/g723_24_decode_bs.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs g723_24 audio decoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API g723_24_decode_bs : virtual public gr_sync_block
{
diff --git a/gr-vocoder/include/vocoder/g723_24_encode_sb.h b/gr-vocoder/include/vocoder/g723_24_encode_sb.h
index 3860ca31c6..c63a9ec84b 100644
--- a/gr-vocoder/include/vocoder/g723_24_encode_sb.h
+++ b/gr-vocoder/include/vocoder/g723_24_encode_sb.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs g723_24 audio encoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API g723_24_encode_sb : virtual public gr_sync_block
{
diff --git a/gr-vocoder/include/vocoder/g723_40_decode_bs.h b/gr-vocoder/include/vocoder/g723_40_decode_bs.h
index 8d00552565..433e74149c 100644
--- a/gr-vocoder/include/vocoder/g723_40_decode_bs.h
+++ b/gr-vocoder/include/vocoder/g723_40_decode_bs.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs g723_40 audio decoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API g723_40_decode_bs : virtual public gr_sync_block
{
diff --git a/gr-vocoder/include/vocoder/g723_40_encode_sb.h b/gr-vocoder/include/vocoder/g723_40_encode_sb.h
index cdab69cdb3..af28996412 100644
--- a/gr-vocoder/include/vocoder/g723_40_encode_sb.h
+++ b/gr-vocoder/include/vocoder/g723_40_encode_sb.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs g723_40 audio encoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API g723_40_encode_sb : virtual public gr_sync_block
{
diff --git a/gr-vocoder/include/vocoder/gsm_fr_decode_ps.h b/gr-vocoder/include/vocoder/gsm_fr_decode_ps.h
index 69aac7a0c8..cda62f19db 100644
--- a/gr-vocoder/include/vocoder/gsm_fr_decode_ps.h
+++ b/gr-vocoder/include/vocoder/gsm_fr_decode_ps.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief GSM 06.10 Full Rate Vocoder Decoder
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API gsm_fr_decode_ps : virtual public gr_sync_interpolator
{
diff --git a/gr-vocoder/include/vocoder/gsm_fr_encode_sp.h b/gr-vocoder/include/vocoder/gsm_fr_encode_sp.h
index a54a8914bc..798e99a3b1 100644
--- a/gr-vocoder/include/vocoder/gsm_fr_encode_sp.h
+++ b/gr-vocoder/include/vocoder/gsm_fr_encode_sp.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief GSM 06.10 Full Rate Vocoder Encoder
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*
* shorts in; 33 byte packets out
*/
diff --git a/gr-vocoder/include/vocoder/ulaw_decode_bs.h b/gr-vocoder/include/vocoder/ulaw_decode_bs.h
index 6d81edc890..74c15531c0 100644
--- a/gr-vocoder/include/vocoder/ulaw_decode_bs.h
+++ b/gr-vocoder/include/vocoder/ulaw_decode_bs.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs ulaw audio decoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API ulaw_decode_bs : virtual public gr_sync_block
{
diff --git a/gr-vocoder/include/vocoder/ulaw_encode_sb.h b/gr-vocoder/include/vocoder/ulaw_encode_sb.h
index 92e562d55e..8d18d00138 100644
--- a/gr-vocoder/include/vocoder/ulaw_encode_sb.h
+++ b/gr-vocoder/include/vocoder/ulaw_encode_sb.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief This block performs g.711 ulaw audio encoding.
- * \ingroup vocoder_blk
+ * \ingroup audio_blk
*/
class VOCODER_API ulaw_encode_sb : virtual public gr_sync_block
{
generated by cgit v1.2.3 (git 2.39.1) at 2025-03-19 10:01:57 +0000