added preliminary documentation

utat-ss · Mar 9, 2024 · 26f47a3 · 26f47a3
1 parent f0babbe
commit 26f47a3
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 8 deletions.
diff --git a/include/gnuradio/UTAT_HERON/esttc_deframer.h b/include/gnuradio/UTAT_HERON/esttc_deframer.h
@@ -15,9 +15,8 @@ namespace gr {
 namespace UTAT_HERON {
 
 /*!
- * \brief <+description of block+>
+ * \brief Identifies ESTTC packets from bitstream, and outputs the payload as PDU
  * \ingroup UTAT_HERON
- *
  */
 class UTAT_HERON_API esttc_deframer : virtual public gr::hier_block2
 {

diff --git a/include/gnuradio/UTAT_HERON/esttc_framer.h b/include/gnuradio/UTAT_HERON/esttc_framer.h
@@ -15,7 +15,7 @@ namespace gr {
 namespace UTAT_HERON {
 
 /*!
- * \brief <+description of block+>
+ * \brief Generates valid ESTTC packets with the input as the payload
  * \ingroup UTAT_HERON
  *
  */

diff --git a/include/gnuradio/UTAT_HERON/header_format_esttc.h b/include/gnuradio/UTAT_HERON/header_format_esttc.h
@@ -16,8 +16,10 @@ namespace gr {
 namespace UTAT_HERON {
 
 /*!
- * \brief <+description+>
+ * \brief Contains instructions on how to generate/indentify ESTTC packet headers
  *
+ * This block does not generate/check CRC. Its primary purpose is to provide information about
+ * packet headers for other blocks to use to actually perform framing and deframing.
  */
 class UTAT_HERON_API header_format_esttc : public gr::digital::header_format_default
 {

diff --git a/include/gnuradio/UTAT_HERON/heron_rx_bb.h b/include/gnuradio/UTAT_HERON/heron_rx_bb.h
@@ -15,9 +15,10 @@ namespace gr {
 namespace UTAT_HERON {
 
 /*!
- * \brief <+description of block+>
+ * \brief Only allow ESTTC packet payloads to pass
  * \ingroup UTAT_HERON
  *
+ * \deprecated Replaced with UTAT_HERON::esttc_deframer
  */
 class UTAT_HERON_API heron_rx_bb : virtual public gr::block
 {

diff --git a/include/gnuradio/UTAT_HERON/tagged_stream_fixed_length_padder.h b/include/gnuradio/UTAT_HERON/tagged_stream_fixed_length_padder.h
@@ -15,9 +15,13 @@ namespace gr {
 namespace UTAT_HERON {
 
 /*!
- * \brief <+description of block+>
+ * \brief Generate data padding to ensure correct number of samples are generated at the end
  * \ingroup UTAT_HERON
  *
+ * Adding padding to IQ data is not a good idea since IQ signals need to follow specific patterns.
+ * Padding should be added to the actual data before modulation. However, we cannot determine the
+ * exact number of samples generated, so this block generated enough padding to overflow, and then
+ * keeps track of the overflow for the next round of padding.
  */
 class UTAT_HERON_API tagged_stream_fixed_length_padder
     : virtual public gr::tagged_stream_block

diff --git a/include/gnuradio/UTAT_HERON/variable_filter.h b/include/gnuradio/UTAT_HERON/variable_filter.h
@@ -15,9 +15,8 @@ namespace gr {
 namespace UTAT_HERON {
 
 /*!
- * \brief <+description of block+>
+ * \brief Allow messages to pass through with specific keys
  * \ingroup UTAT_HERON
- *
  */
 class UTAT_HERON_API variable_filter : virtual public gr::block
 {