aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorDimitri Stolnikov <horiz0n@gmx.net>2012-04-28 23:51:00 +0200
committerDimitri Stolnikov <horiz0n@gmx.net>2012-04-28 23:51:00 +0200
commitb41c85a2b04470ec1f0017c7ce792231782c2496 (patch)
treebfa71c71de2ae2e0c18c7904184dd4301c786959 /include
parent0216d1022be821fe410f404c2345286c46f1a09f (diff)
fix interface documentation
Diffstat (limited to 'include')
-rw-r--r--include/osmosdr/osmosdr_pimpl.h2
-rw-r--r--include/osmosdr/osmosdr_source_c.h1
2 files changed, 2 insertions, 1 deletions
diff --git a/include/osmosdr/osmosdr_pimpl.h b/include/osmosdr/osmosdr_pimpl.h
index 84808c7..b06e0d8 100644
--- a/include/osmosdr/osmosdr_pimpl.h
+++ b/include/osmosdr/osmosdr_pimpl.h
@@ -20,7 +20,7 @@
#include <boost/shared_ptr.hpp>
-/*! \file pimpl.hpp
+/*! \file osmosdr_pimpl.h
* "Pimpl idiom" (pointer to implementation idiom).
* The OSMOSDR_PIMPL_* macros simplify code overhead for declaring and making pimpls.
*
diff --git a/include/osmosdr/osmosdr_source_c.h b/include/osmosdr/osmosdr_source_c.h
index a9cf0b5..f5d603a 100644
--- a/include/osmosdr/osmosdr_source_c.h
+++ b/include/osmosdr/osmosdr_source_c.h
@@ -190,6 +190,7 @@ public:
/*!
* Select the active antenna of the underlying radio hardware.
+ * \param antenna name of the antenna to be selected
* \param chan the channel index 0 to N-1
* \return the actual antenna's name
*/