[Commit-gnuradio] [gnuradio] 11/15: gnuradio-runtime: append docs to set_history regarding initialization

[git]

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

jcorgan pushed a commit to branch master
in repository gnuradio.

commit bd10336e4e1fcf2bb841c51f6580bddc1b28eb3e
Author: Andrej Rode <address@hidden>
Date:   Tue Feb 9 18:38:40 2016 +0100

    gnuradio-runtime: append docs to set_history regarding initialization
---
 gnuradio-runtime/include/gnuradio/block.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/gnuradio-runtime/include/gnuradio/block.h 
b/gnuradio-runtime/include/gnuradio/block.h
index c6185d9..a484ccf 100644
--- a/gnuradio-runtime/include/gnuradio/block.h
+++ b/gnuradio-runtime/include/gnuradio/block.h
@@ -80,7 +80,9 @@ namespace gr {
      * History is the number of x_i's that are examined to produce one y_i.
      * This comes in handy for FIR filters, where we use history to
      * ensure that our input contains the appropriate "history" for the
-     * filter. History should be equal to the number of filter taps.
+     * filter. History should be equal to the number of filter taps. First
+     * history samples (when there are no previous samples) are
+     * initialized with zeroes.
      */
     unsigned history() const;
     void  set_history(unsigned history);