diff options
| author | Tom Rondeau <tom@trondeau.com> | 2013-10-06 15:19:23 -0400 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2013-10-06 16:17:22 -0400 |
| commit | fc2253f8db42dc184dad2db072347c942b0ed9fe (patch) | |
| tree | 119d351bc51ece61850652712792bdf1369b9fed | |
| parent | 03ed4becd5b90d482b68cad397ce6b6d3e59712e (diff) | |
filter: sets comments for windows to export into Doxygen manual.
| -rw-r--r-- | gr-filter/include/gnuradio/filter/firdes.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/gr-filter/include/gnuradio/filter/firdes.h b/gr-filter/include/gnuradio/filter/firdes.h index 7f8b944002..bd09cd801d 100644 --- a/gr-filter/include/gnuradio/filter/firdes.h +++ b/gr-filter/include/gnuradio/filter/firdes.h @@ -40,14 +40,14 @@ namespace gr { public: enum win_type { - WIN_NONE = -1, // don't use a window - WIN_HAMMING = 0, // max attenuation 53 dB - WIN_HANN = 1, // max attenuation 44 dB - WIN_BLACKMAN = 2, // max attenuation 74 dB - WIN_RECTANGULAR = 3, - WIN_KAISER = 4, // max attenuation a function of beta, google it - WIN_BLACKMAN_hARRIS = 5, - WIN_BLACKMAN_HARRIS = 5, // alias for capitalization consistency + WIN_NONE = -1, //!< don't use a window + WIN_HAMMING = 0, //!< Hamming window; max attenuation 53 dB + WIN_HANN = 1, //!< Hann window; max attenuation 44 dB + WIN_BLACKMAN = 2, //!< Blackman window; max attenuation 74 dB + WIN_RECTANGULAR = 3, //!< Basic rectangular window + WIN_KAISER = 4, //!< Kaiser window; max attenuation a function of beta, google it + WIN_BLACKMAN_hARRIS = 5, //!< Blackman-harris window + WIN_BLACKMAN_HARRIS = 5, //!< alias to WIN_BLACKMAN_hARRIS for capitalization consistency }; |