summaryrefslogtreecommitdiff
path: root/gr-analog/include/analog/frequency_modulator_fc.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-analog/include/analog/frequency_modulator_fc.h')
-rw-r--r--gr-analog/include/analog/frequency_modulator_fc.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/gr-analog/include/analog/frequency_modulator_fc.h b/gr-analog/include/analog/frequency_modulator_fc.h
index 8706d513a6..67be1ff00e 100644
--- a/gr-analog/include/analog/frequency_modulator_fc.h
+++ b/gr-analog/include/analog/frequency_modulator_fc.h
@@ -41,6 +41,11 @@ namespace gr {
// gr::analog::frequency_modulator_fc::sptr
typedef boost::shared_ptr<frequency_modulator_fc> sptr;
+ /*!
+ * Build a frequency modulator block.
+ *
+ * \param sensitivity radians/sample = amplitude * sensitivity
+ */
static sptr make(double sensitivity);
virtual void set_sensitivity(float sens) = 0;