Imported Upstream version 3.2.2

[debian/gnuradio] / gnuradio-core / src / lib / general / gr_simple_framer_sync.h

diff --git a/gnuradio-core/src/lib/general/gr_simple_framer_sync.h b/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
index 2bda708e10fcbbe49637d0d19c74ebbecfd6a2c7..d5712fe8e23472de82cce274618e41d415ccdf2f 100644 (file)
--- a/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
+++ b/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
@@ -23,11 +23,12 @@
 #ifndef INCLUDED_GR_SIMPLE_FRAMER_SYNC_H
 #define INCLUDED_GR_SIMPLE_FRAMER_SYNC_H
 
-/*
- * Here are a couple of maximum length sequences (m-sequences) that were generated by the
+/*!
+ * \brief Here are a couple of maximum length sequences (m-sequences) that were generated by the
  * the "mseq" matlab/octave code downloaded from:
  * http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?objectId=990&objectType=file
  *
+ * <pre>
  * 31-bit m-sequence:
  *     0110100100001010111011000111110
  *     0x690AEC76 (padded on right with a zero)
@@ -35,6 +36,7 @@
  * 63-bit m-sequence:
  *     101011001101110110100100111000101111001010001100001000001111110
  *      0xACDDA4E2F28C20FC (padded on right with a zero)
+ * </pre>
  */
 
 static const unsigned long long GRSF_SYNC = 0xacdda4e2f28c20fcULL;