[Commit-gnuradio] [gnuradio] 08/11: analog: additional docs for noise sources.

[git]

This is an automated email from the git hooks/post-receive script.

trondeau pushed a commit to branch maint
in repository gnuradio.

commit 513e94794d8663b85bd2ab9d60b876d17967bd41
Author: Tom Rondeau <address@hidden>
Date:   Thu Jan 9 09:33:23 2014 -0500

    analog: additional docs for noise sources.
---
 gr-analog/include/gnuradio/analog/fastnoise_source_X.h.t | 4 ++--
 gr-analog/include/gnuradio/analog/noise_source_X.h.t     | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/gr-analog/include/gnuradio/analog/fastnoise_source_X.h.t 
b/gr-analog/include/gnuradio/analog/fastnoise_source_X.h.t
index 5f94a7e..a6377ad 100644
--- a/gr-analog/include/gnuradio/analog/fastnoise_source_X.h.t
+++ b/gr-analog/include/gnuradio/analog/fastnoise_source_X.h.t
@@ -48,10 +48,10 @@ namespace gr {
 
       /*! \brief Make a fast noise source
        * \param type    the random distribution to use (see 
gnuradio/analog/noise_type.h)
-       * \param ampl    a scaling factor for the output
+       * \param ampl    a scaling factor for the output; for Gaussian sources, 
this is the std. dev.
        * \param seed    seed for random generators. Note that for uniform and
+       *                Gaussian distributions, this should be a negative 
number.
        * \param samples Number of samples to pre-generate
-       * Gaussian distributions, this should be a negative number.
        */
       static sptr make(noise_type_t type, float ampl,
                       long seed = 0, long samples=1024*16);
diff --git a/gr-analog/include/gnuradio/analog/noise_source_X.h.t 
b/gr-analog/include/gnuradio/analog/noise_source_X.h.t
index b7b0906..6e3ff3e 100644
--- a/gr-analog/include/gnuradio/analog/noise_source_X.h.t
+++ b/gr-analog/include/gnuradio/analog/noise_source_X.h.t
@@ -48,7 +48,7 @@ namespace gr {
 
       /*! Build a noise source
        * \param type the random distribution to use (see 
gnuradio/analog/noise_type.h)
-       * \param ampl a scaling factor for the output
+       * \param ampl a scaling factor for the output; for Gaussian sources, 
this is the std. dev.
        * \param seed seed for random generators. Note that for uniform and
        *             Gaussian distributions, this should be a negative number.
        */