Doc updates only

git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@9563 221aa14e-8319-0410-a670-987f0aec2ac5

diff --git a/gnuradio-core/src/lib/general/gr_descrambler_bb.h b/gnuradio-core/src/lib/general/gr_descrambler_bb.h
index 4fd8f4a0ffcd6a46c186f096e3bac4f4fc02e426..9e66ceff23807fae5ec36789554f054e6b71e62e 100644 (file)
--- a/gnuradio-core/src/lib/general/gr_descrambler_bb.h
+++ b/gnuradio-core/src/lib/general/gr_descrambler_bb.h
@@ -31,7 +31,9 @@ typedef boost::shared_ptr<gr_descrambler_bb> gr_descrambler_bb_sptr;
 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

diff --git a/gnuradio-core/src/lib/general/gr_scrambler_bb.h b/gnuradio-core/src/lib/general/gr_scrambler_bb.h
index a01b08dd6a015a5e77e24bbe3afbaa2d2911877c..1dfa60dfb5700c1dd0b0d4b91910451573553ac5 100644 (file)
--- a/gnuradio-core/src/lib/general/gr_scrambler_bb.h
+++ b/gnuradio-core/src/lib/general/gr_scrambler_bb.h
@@ -31,7 +31,9 @@ typedef boost::shared_ptr<gr_scrambler_bb> gr_scrambler_bb_sptr;
 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

diff --git a/gnuradio-core/src/lib/general/gri_lfsr.h b/gnuradio-core/src/lib/general/gri_lfsr.h
index b6eee76793f393824455cf2972e4ef70af3bfba5..090caab8218ba84fc5c99ccb19c9bb2acc4d7a92 100644 (file)
--- a/gnuradio-core/src/lib/general/gri_lfsr.h
+++ b/gnuradio-core/src/lib/general/gri_lfsr.h
@@ -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

diff --git a/gnuradio-core/src/lib/general/qa_gri_lfsr.cc b/gnuradio-core/src/lib/general/qa_gri_lfsr.cc
index 2d4346aceca0a4cff074e1b65d56bcf6caff3584..fb2ca06c0acdf86689b4f6eec403d95d3c19a2e7 100644 (file)
--- a/gnuradio-core/src/lib/general/qa_gri_lfsr.cc
+++ b/gnuradio-core/src/lib/general/qa_gri_lfsr.cc
@@ -58,7 +58,7 @@ void
 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;