diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-03-13 23:03:15 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-03-13 23:03:15 -0400 |
| commit | 3e7d338c626a94b9073db3c57b90ab5d9f35b7f4 (patch) | |
| tree | 405a248bcdb0ecc781d55334239aaa0b2317cdb9 /gr-analog/include/analog/rail_ff.h | |
| parent | 9616494c07b86b8b76c3c49c66fe9dfa037989e7 (diff) | |
analog: added some documentation for a number of blocks.
Diffstat (limited to 'gr-analog/include/analog/rail_ff.h')
| -rw-r--r-- | gr-analog/include/analog/rail_ff.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/gr-analog/include/analog/rail_ff.h b/gr-analog/include/analog/rail_ff.h index e51b2fc935..120ca2815b 100644 --- a/gr-analog/include/analog/rail_ff.h +++ b/gr-analog/include/analog/rail_ff.h @@ -39,6 +39,12 @@ namespace gr { // gr::analog::rail_ff::sptr typedef boost::shared_ptr<rail_ff> sptr; + /*! + * Build a rail block. + * + * \param lo the low value to clip to. + * \param hi the high value to clip to. + */ static sptr make(float lo, float hi); virtual float lo() const = 0; |