summaryrefslogtreecommitdiff
path: root/gr-trellis/include/trellis
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-trellis/include/trellis
parent2930f1b4265b794599d814e9a3d68fd03bde010f (diff)
docs: fixes for merge conflicts and differences between master/next.
Diffstat (limited to 'gr-trellis/include/trellis')
-rw-r--r--gr-trellis/include/trellis/constellation_metrics_cf.h2
-rw-r--r--gr-trellis/include/trellis/encoder_XX.h.t2
-rw-r--r--gr-trellis/include/trellis/fsm.h2
-rw-r--r--gr-trellis/include/trellis/interleaver.h1
-rw-r--r--gr-trellis/include/trellis/metrics_X.h.t2
-rw-r--r--gr-trellis/include/trellis/pccc_decoder_X.h.t2
-rw-r--r--gr-trellis/include/trellis/pccc_decoder_combined_XX.h.t2
-rw-r--r--gr-trellis/include/trellis/pccc_encoder_XX.h.t16
-rw-r--r--gr-trellis/include/trellis/permutation.h2
-rw-r--r--gr-trellis/include/trellis/sccc_decoder_X.h.t2
-rw-r--r--gr-trellis/include/trellis/sccc_decoder_combined_XX.h.t2
-rw-r--r--gr-trellis/include/trellis/sccc_encoder_XX.h.t2
-rw-r--r--gr-trellis/include/trellis/siso_combined_f.h2
-rw-r--r--gr-trellis/include/trellis/siso_f.h2
-rw-r--r--gr-trellis/include/trellis/viterbi_X.h.t2
-rw-r--r--gr-trellis/include/trellis/viterbi_combined_XX.h.t2
16 files changed, 24 insertions, 21 deletions
diff --git a/gr-trellis/include/trellis/constellation_metrics_cf.h b/gr-trellis/include/trellis/constellation_metrics_cf.h
index 2dca6f7b5b..f4b94223c7 100644
--- a/gr-trellis/include/trellis/constellation_metrics_cf.h
+++ b/gr-trellis/include/trellis/constellation_metrics_cf.h
@@ -33,7 +33,7 @@ namespace gr {
/*!
* \brief Evaluate metrics for use by the Viterbi algorithm.
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API constellation_metrics_cf : virtual public gr_block
{
diff --git a/gr-trellis/include/trellis/encoder_XX.h.t b/gr-trellis/include/trellis/encoder_XX.h.t
index c10b283f87..9ca7cb30ce 100644
--- a/gr-trellis/include/trellis/encoder_XX.h.t
+++ b/gr-trellis/include/trellis/encoder_XX.h.t
@@ -34,7 +34,7 @@ namespace gr {
/*!
* \brief Convolutional encoder.
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_sync_block
{
diff --git a/gr-trellis/include/trellis/fsm.h b/gr-trellis/include/trellis/fsm.h
index a69925c1c7..d88732b29b 100644
--- a/gr-trellis/include/trellis/fsm.h
+++ b/gr-trellis/include/trellis/fsm.h
@@ -32,7 +32,9 @@ namespace gr {
/*!
* \brief Finite State Machine Specification class.
+ * \ingroup trellis_coding_blk
*
+ * \details
* An instance of this class represents a finite state machine
* specification (FSMS) rather than the FSM itself. It particular
* the state of the FSM is not stored within an instance of this
diff --git a/gr-trellis/include/trellis/interleaver.h b/gr-trellis/include/trellis/interleaver.h
index 7465f17986..35fff0ac88 100644
--- a/gr-trellis/include/trellis/interleaver.h
+++ b/gr-trellis/include/trellis/interleaver.h
@@ -31,6 +31,7 @@ namespace gr {
/*!
* \brief INTERLEAVER class
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API interleaver
{
diff --git a/gr-trellis/include/trellis/metrics_X.h.t b/gr-trellis/include/trellis/metrics_X.h.t
index 5605130c24..dab7924a8b 100644
--- a/gr-trellis/include/trellis/metrics_X.h.t
+++ b/gr-trellis/include/trellis/metrics_X.h.t
@@ -34,7 +34,7 @@ namespace gr {
/*!
* \brief Evaluate metrics for use by the Viterbi algorithm.
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_block
{
diff --git a/gr-trellis/include/trellis/pccc_decoder_X.h.t b/gr-trellis/include/trellis/pccc_decoder_X.h.t
index 4ab1c088a5..d5b6af7b87 100644
--- a/gr-trellis/include/trellis/pccc_decoder_X.h.t
+++ b/gr-trellis/include/trellis/pccc_decoder_X.h.t
@@ -36,7 +36,7 @@ namespace gr {
namespace trellis {
/*!
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_block
{
diff --git a/gr-trellis/include/trellis/pccc_decoder_combined_XX.h.t b/gr-trellis/include/trellis/pccc_decoder_combined_XX.h.t
index 1ea53329c4..87b110a945 100644
--- a/gr-trellis/include/trellis/pccc_decoder_combined_XX.h.t
+++ b/gr-trellis/include/trellis/pccc_decoder_combined_XX.h.t
@@ -37,7 +37,7 @@ namespace gr {
namespace trellis {
/*!
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_block
{
diff --git a/gr-trellis/include/trellis/pccc_encoder_XX.h.t b/gr-trellis/include/trellis/pccc_encoder_XX.h.t
index 103301eecd..2a62b7520f 100644
--- a/gr-trellis/include/trellis/pccc_encoder_XX.h.t
+++ b/gr-trellis/include/trellis/pccc_encoder_XX.h.t
@@ -35,8 +35,8 @@ namespace gr {
namespace trellis {
/*!
- * \brief SCCC encoder.
- * \ingroup coding_blk
+ * \brief PCCC encoder.
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_sync_block
{
@@ -49,12 +49,12 @@ namespace gr {
const interleaver &INTERLEAVER,
int blocklength);
- virtual fsm FSM1 () const = 0;
- virtual int ST1 () const = 0;
- virtual fsm FSM2 () const = 0;
- virtual int ST2 () const = 0;
- virtual interleaver INTERLEAVER () const = 0;
- virtual int blocklength () const = 0;
+ virtual fsm FSM1() const = 0;
+ virtual int ST1() const = 0;
+ virtual fsm FSM2() const = 0;
+ virtual int ST2() const = 0;
+ virtual interleaver INTERLEAVER() const = 0;
+ virtual int blocklength() const = 0;
};
} /* namespace trellis */
diff --git a/gr-trellis/include/trellis/permutation.h b/gr-trellis/include/trellis/permutation.h
index adfe44a576..0f974abb97 100644
--- a/gr-trellis/include/trellis/permutation.h
+++ b/gr-trellis/include/trellis/permutation.h
@@ -32,7 +32,7 @@ namespace gr {
/*!
* \brief Permutation.
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API permutation : virtual public gr_sync_block
{
diff --git a/gr-trellis/include/trellis/sccc_decoder_X.h.t b/gr-trellis/include/trellis/sccc_decoder_X.h.t
index f2faa97e26..1a63facad9 100644
--- a/gr-trellis/include/trellis/sccc_decoder_X.h.t
+++ b/gr-trellis/include/trellis/sccc_decoder_X.h.t
@@ -36,7 +36,7 @@ namespace gr {
namespace trellis {
/*!
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_block
{
diff --git a/gr-trellis/include/trellis/sccc_decoder_combined_XX.h.t b/gr-trellis/include/trellis/sccc_decoder_combined_XX.h.t
index fbc3d8d668..f5f9bef464 100644
--- a/gr-trellis/include/trellis/sccc_decoder_combined_XX.h.t
+++ b/gr-trellis/include/trellis/sccc_decoder_combined_XX.h.t
@@ -37,7 +37,7 @@ namespace gr {
namespace trellis {
/*!
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_block
{
diff --git a/gr-trellis/include/trellis/sccc_encoder_XX.h.t b/gr-trellis/include/trellis/sccc_encoder_XX.h.t
index 7702d06faf..f62a1e7cfb 100644
--- a/gr-trellis/include/trellis/sccc_encoder_XX.h.t
+++ b/gr-trellis/include/trellis/sccc_encoder_XX.h.t
@@ -36,7 +36,7 @@ namespace gr {
/*!
* \brief SCCC encoder.
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_sync_block
{
diff --git a/gr-trellis/include/trellis/siso_combined_f.h b/gr-trellis/include/trellis/siso_combined_f.h
index c67a296885..48089f86e4 100644
--- a/gr-trellis/include/trellis/siso_combined_f.h
+++ b/gr-trellis/include/trellis/siso_combined_f.h
@@ -34,7 +34,7 @@ namespace gr {
namespace trellis {
/*!
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API siso_combined_f : virtual public gr_block
{
diff --git a/gr-trellis/include/trellis/siso_f.h b/gr-trellis/include/trellis/siso_f.h
index da35e14a0b..6d4d414f38 100644
--- a/gr-trellis/include/trellis/siso_f.h
+++ b/gr-trellis/include/trellis/siso_f.h
@@ -33,7 +33,7 @@ namespace gr {
namespace trellis {
/*!
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API siso_f : virtual public gr_block
{
diff --git a/gr-trellis/include/trellis/viterbi_X.h.t b/gr-trellis/include/trellis/viterbi_X.h.t
index 6931eb37e5..817c98508a 100644
--- a/gr-trellis/include/trellis/viterbi_X.h.t
+++ b/gr-trellis/include/trellis/viterbi_X.h.t
@@ -34,7 +34,7 @@ namespace gr {
namespace trellis {
/*!
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_block
{
diff --git a/gr-trellis/include/trellis/viterbi_combined_XX.h.t b/gr-trellis/include/trellis/viterbi_combined_XX.h.t
index 77fc5a5a60..a2cc4b946c 100644
--- a/gr-trellis/include/trellis/viterbi_combined_XX.h.t
+++ b/gr-trellis/include/trellis/viterbi_combined_XX.h.t
@@ -35,7 +35,7 @@ namespace gr {
namespace trellis {
/*!
- * \ingroup coding_blk
+ * \ingroup trellis_coding_blk
*/
class TRELLIS_API @NAME@ : virtual public gr_block
{
generated by cgit v1.2.3 (git 2.39.1) at 2025-03-21 01:24:36 +0000