summaryrefslogtreecommitdiff
path: root/gr-blocks/include/gnuradio/blocks/file_meta_sink.h
diff options
context:
space:
mode:
authorTom Rondeau <tom@trondeau.com>2013-11-23 20:01:19 -0500
committerTom Rondeau <tom@trondeau.com>2013-11-23 20:01:19 -0500
commit424c8d2ea4a48125ec3226af1514a5787c9a157e (patch)
treed4e46bb8a2a3184e656a311d8c3f7427d647035b /gr-blocks/include/gnuradio/blocks/file_meta_sink.h
parentc76c10d43f0c7a086700fcc8c6dc8740243aa745 (diff)
docs: fixed/modifying/adding documentation for blocks a-l.
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/file_meta_sink.h')
-rw-r--r--gr-blocks/include/gnuradio/blocks/file_meta_sink.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/file_meta_sink.h b/gr-blocks/include/gnuradio/blocks/file_meta_sink.h
index 55b8b9801e..0d68132f0d 100644
--- a/gr-blocks/include/gnuradio/blocks/file_meta_sink.h
+++ b/gr-blocks/include/gnuradio/blocks/file_meta_sink.h
@@ -53,13 +53,13 @@ namespace gr {
* type of data and properties of the data in the next segment of
* samples. The information includes:
*
- * rx_rate (double): sample rate of data.
- * rx_time (uint64_t, double): time stamp of first sample in segment.
- * size (uint32_t): item size in bytes.
- * type (gr_file_types as int32_t): data type.
- * cplx (bool): Is data complex?
- * strt (uint64_t): Starting byte of data in this segment.
- * bytes (uint64_t): Size in bytes of data in this segment.
+ * \li rx_rate (double): sample rate of data.
+ * \li rx_time (uint64_t, double): time stamp of first sample in segment.
+ * \li size (uint32_t): item size in bytes.
+ * \li type (::gr_file_types as int32_t): data type.
+ * \li cplx (bool): Is data complex?
+ * \li strt (uint64_t): Starting byte of data in this segment.
+ * \li bytes (uint64_t): Size in bytes of data in this segment.
*
* Tags can be sent to the file to update the information, which
* will create a new header. Headers are found by searching from