diff options
| author | Kevin Reid <kpreid@switchb.org> | 2014-07-07 10:52:10 -0400 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2014-07-07 10:52:29 -0400 |
| commit | e6a396f21c3794462c4db4930a590551ba548952 (patch) | |
| tree | 3b28885ef08c32f067043549bd84c87974e8d4eb /gr-blocks/include/gnuradio/blocks/file_descriptor_source.h | |
| parent | a6c837e184f4bbf6a0d5c15b8c9ca75294a64f0f (diff) | |
docs: Corrects or expands documentation comments for various blocks where I have had to read the source code to understand the
- char_to_short and short_to_char scale by a factor of 1<<8.
- What delay actually does.
- File descriptor blocks close their FDs when destroyed.
And one code change:
The firdes transition width check error text is made consistent with other similar messages.
Addresses Issue #686.
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/file_descriptor_source.h')
| -rw-r--r-- | gr-blocks/include/gnuradio/blocks/file_descriptor_source.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/file_descriptor_source.h b/gr-blocks/include/gnuradio/blocks/file_descriptor_source.h index 6292b6357b..d78b10a84f 100644 --- a/gr-blocks/include/gnuradio/blocks/file_descriptor_source.h +++ b/gr-blocks/include/gnuradio/blocks/file_descriptor_source.h @@ -46,7 +46,8 @@ namespace gr { typedef boost::shared_ptr<file_descriptor_source> sptr; /*! - * Build a file descriptor source block. + * Build a file descriptor source block. The provided file descriptor will + * be closed when the sink is destroyed. * * \param itemsize item size of the incoming data stream. * \param fd file descriptor (as an integer). |