[Commit-gnuradio] r9563 - gnuradio/trunk/gnuradio-core/src/lib/general

[jcorgan]

Author: jcorgan
Date: 2008-09-12 12:29:00 -0600 (Fri, 12 Sep 2008)
New Revision: 9563

Modified:
   gnuradio/trunk/gnuradio-core/src/lib/general/gr_descrambler_bb.h
   gnuradio/trunk/gnuradio-core/src/lib/general/gr_scrambler_bb.h
   gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr.h
   gnuradio/trunk/gnuradio-core/src/lib/general/qa_gri_lfsr.cc
Log:
Doc updates only

Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_descrambler_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_descrambler_bb.h    
2008-09-12 02:56:36 UTC (rev 9562)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_descrambler_bb.h    
2008-09-12 18:29:00 UTC (rev 9563)
@@ -31,7 +31,9 @@
 gr_descrambler_bb_sptr gr_make_descrambler_bb(int mask, int seed, int len);
 
 /*!
- * \brief Descramble an input stream using an LFSR
+ * Descramble an input stream using an LFSR.  This block works on the LSB only
+ * of the input data stream, i.e., on an "unpacked binary" stream, and
+ * produces the same format on its output.
  * 
  * \param mask     Polynomial mask for LFSR
  * \param seed     Initial shift register contents

Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_scrambler_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_scrambler_bb.h      
2008-09-12 02:56:36 UTC (rev 9562)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_scrambler_bb.h      
2008-09-12 18:29:00 UTC (rev 9563)
@@ -31,7 +31,9 @@
 gr_scrambler_bb_sptr gr_make_scrambler_bb(int mask, int seed, int len);
 
 /*!
- * \brief Scramble an input stream using an LFSR
+ * Scramble an input stream using an LFSR.  This block works on the LSB only
+ * of the input data stream, i.e., on an "unpacked binary" stream, and 
+ * produces the same format on its output.
  * 
  * \param mask     Polynomial mask for LFSR
  * \param seed     Initial shift register contents

Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr.h     2008-09-12 
02:56:36 UTC (rev 9562)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr.h     2008-09-12 
18:29:00 UTC (rev 9563)
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2007 Free Software Foundation, Inc.
+ * Copyright 2008 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
@@ -73,7 +73,7 @@
  *  next_bit_descramble(unsigned char input) - Descramble an input stream
  *
  *      Perform one cycle of the LFSR.  The output bit is taken from 
- *      the modulo-2 sum of the masked shift register and the input LSB.
+ *      the modulo 2 sum of the masked shift register and the input LSB.
  *      The shift register MSB is assigned from the LSB of the input.
  *
  * See http://en.wikipedia.org/wiki/Scrambler for operation of these

Modified: gnuradio/trunk/gnuradio-core/src/lib/general/qa_gri_lfsr.cc
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/qa_gri_lfsr.cc 2008-09-12 
02:56:36 UTC (rev 9562)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/qa_gri_lfsr.cc 2008-09-12 
18:29:00 UTC (rev 9563)
@@ -58,7 +58,7 @@
 qa_gri_lfsr::test_scrambler()
 {
   // CCSDS 7-bit scrambler
-  int mask = 0x8A; // 1+x^4+X^6 
+  int mask = 0x8A;
   int seed = 0x7F;
   int length = 7;