aboutsummaryrefslogtreecommitdiffstats
path: root/include/osmosdr
diff options
context:
space:
mode:
authorDimitri Stolnikov <horiz0n@gmx.net>2012-05-17 10:35:58 +0200
committerDimitri Stolnikov <horiz0n@gmx.net>2012-05-17 10:35:58 +0200
commit6bef750ac9b779fb28315b7c3f9385eddfdc3314 (patch)
tree341d767ec7b567c012e623c8217663700057fe40 /include/osmosdr
parent8748ee2b56c9cd9d2d316fd0a9e7b01a0910446f (diff)
change gain mode argument to 'automatic' for clarity
Diffstat (limited to 'include/osmosdr')
-rw-r--r--include/osmosdr/osmosdr_source_c.h6
1 files changed, 3 insertions, 3 deletions
diff --git a/include/osmosdr/osmosdr_source_c.h b/include/osmosdr/osmosdr_source_c.h
index 1da922b..425902d 100644
--- a/include/osmosdr/osmosdr_source_c.h
+++ b/include/osmosdr/osmosdr_source_c.h
@@ -148,16 +148,16 @@ public:
/*!
* Set the gain mode for the underlying radio hardware.
* This might be supported only for certain hardware types.
- * \param mode the gain mode (true means automatic gain mode)
+ * \param automatic the gain mode (true means automatic gain mode)
* \param chan the channel index 0 to N-1
* \return the actual gain mode
*/
- virtual bool set_gain_mode( bool mode, size_t chan = 0 ) = 0;
+ virtual bool set_gain_mode( bool automatic, size_t chan = 0 ) = 0;
/*!
* Get the gain mode selected for the underlying radio hardware.
* \param chan the channel index 0 to N-1
- * \return the actual gain mode
+ * \return the actual gain mode (true means automatic gain mode)
*/
virtual bool get_gain_mode( size_t chan = 0 ) = 0;