[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Commit-gnuradio] [gnuradio] 02/05: docs: fixed a few warnings.
From: |
git |
Subject: |
[Commit-gnuradio] [gnuradio] 02/05: docs: fixed a few warnings. |
Date: |
Tue, 18 Mar 2014 17:51:31 +0000 (UTC) |
This is an automated email from the git hooks/post-receive script.
trondeau pushed a commit to branch maint
in repository gnuradio.
commit c7c08e70f099dc04bb254b43812aef42d109dde3
Author: Tom Rondeau <address@hidden>
Date: Tue Mar 18 09:56:48 2014 -0400
docs: fixed a few warnings.
---
gr-qtgui/include/gnuradio/qtgui/utils.h | 2 +-
gr-vocoder/include/gnuradio/vocoder/cvsd_decode_bs.h | 4 ++--
gr-vocoder/include/gnuradio/vocoder/cvsd_encode_sb.h | 4 ++--
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/gr-qtgui/include/gnuradio/qtgui/utils.h
b/gr-qtgui/include/gnuradio/qtgui/utils.h
index 4b2623d..2c51b24 100644
--- a/gr-qtgui/include/gnuradio/qtgui/utils.h
+++ b/gr-qtgui/include/gnuradio/qtgui/utils.h
@@ -33,7 +33,7 @@
* From QSS file name, extracts the file contents and returns a
* QString that contains the QSS information. Designed to be passed to
* the qApplication. The QSS file is typically retrieved using the
- * [qtgui] qss=<filename> section of the preferences files.
+ * [qtgui] qss=\<filename\> section of the preferences files.
*/
QTGUI_API QString get_qt_style_sheet(QString filename);
diff --git a/gr-vocoder/include/gnuradio/vocoder/cvsd_decode_bs.h
b/gr-vocoder/include/gnuradio/vocoder/cvsd_decode_bs.h
index 6e93168..bacc5ae 100644
--- a/gr-vocoder/include/gnuradio/vocoder/cvsd_decode_bs.h
+++ b/gr-vocoder/include/gnuradio/vocoder/cvsd_decode_bs.h
@@ -105,9 +105,9 @@ namespace gr {
* Default: "0.9990234375" (i.e. 1-1/1024)
* \param accum_decay Decay factor applied to the internal reference
during every interation of the codec.
* Default: "0.96875" (i.e. 1-1/32)
- * \param K; Size of shift register; the number of output
bits remembered by codec (must be <= to 32).
+ * \param K Size of shift register; the number of output
bits remembered by codec (must be <= to 32).
* Default: "32"
- * \param J; Number of bits in the shift register that are
equal; i.e. the size of a run of 1s, 0s.
+ * \param J Number of bits in the shift register that are
equal; i.e. the size of a run of 1s, 0s.
* Default: "4"
* \param pos_accum_max Maximum integer value allowed for the internal
reference.
* Default: "32767" (2^15 - 1 or MAXSHORT)
diff --git a/gr-vocoder/include/gnuradio/vocoder/cvsd_encode_sb.h
b/gr-vocoder/include/gnuradio/vocoder/cvsd_encode_sb.h
index d0b3afa..da1e92f 100644
--- a/gr-vocoder/include/gnuradio/vocoder/cvsd_encode_sb.h
+++ b/gr-vocoder/include/gnuradio/vocoder/cvsd_encode_sb.h
@@ -101,9 +101,9 @@ namespace gr {
* Default: "0.9990234375" (i.e. 1-1/1024)
* \param accum_decay Decay factor applied to the internal reference
during every interation of the codec.
* Default: "0.96875" (i.e. 1-1/32)
- * \param K; Size of shift register; the number of output
bits remembered by codec (must be <= to 32).
+ * \param K Size of shift register; the number of output
bits remembered by codec (must be <= to 32).
* Default: "32"
- * \param J; Number of bits in the shift register that are
equal; i.e. the size of a run of 1s, 0s.
+ * \param J Number of bits in the shift register that are
equal; i.e. the size of a run of 1s, 0s.
* Default: "4"
* \param pos_accum_max Maximum integer value allowed for the internal
reference.
* Default: "32767" (2^15 - 1 or MAXSHORT)