From a100eb024c0210b95e4738b6efd836d48225bd03 Mon Sep 17 00:00:00 2001 From: Ron Economos Date: Thu, 28 Jan 2021 09:02:06 -0800 Subject: [PATCH] Remove Doxygen warnings. Signed-off-by: Ron Economos Signed-off-by: Eric Wild --- include/osmosdr/source.h | 1 + lib/sink_iface.h | 1 + lib/source_iface.h | 2 ++ python/bindings/python_bindings.cc | 12 ++++++------ python/bindings/source_python.cc | 2 +- 5 files changed, 11 insertions(+), 7 deletions(-) diff --git a/include/osmosdr/source.h b/include/osmosdr/source.h index 3ea716d..20c77b1 100644 --- a/include/osmosdr/source.h +++ b/include/osmosdr/source.h @@ -63,6 +63,7 @@ public: * * \param seek_point sample offset in file * \param whence one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek) + * \param chan the channel index 0 to N-1 * \return true on success */ virtual bool seek( long seek_point, int whence, size_t chan = 0 ) = 0; diff --git a/lib/sink_iface.h b/lib/sink_iface.h index 39aabc7..15ea952 100644 --- a/lib/sink_iface.h +++ b/lib/sink_iface.h @@ -201,6 +201,7 @@ public: /*! * Select the active antenna of the underlying radio hardware. + * \param antenna the antenna name * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ diff --git a/lib/source_iface.h b/lib/source_iface.h index abb70eb..14f05bb 100644 --- a/lib/source_iface.h +++ b/lib/source_iface.h @@ -43,6 +43,7 @@ public: * * \param seek_point sample offset in file * \param whence one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek) + * \param chan the channel index 0 to N-1 * \return true on success */ virtual bool seek( long seek_point, int whence, size_t chan = 0 ) { return false; } @@ -210,6 +211,7 @@ public: /*! * Select the active antenna of the underlying radio hardware. + * \param antenna the antenna name * \param chan the channel index 0 to N-1 * \return the actual antenna's name */ diff --git a/python/bindings/python_bindings.cc b/python/bindings/python_bindings.cc index 7204b2b..428417d 100644 --- a/python/bindings/python_bindings.cc +++ b/python/bindings/python_bindings.cc @@ -16,9 +16,9 @@ namespace py = pybind11; // Headers for binding functions /**************************************/ -/* The following comment block is used for -/* gr_modtool to insert function prototypes -/* Please do not delete +// The following comment block is used for +// gr_modtool to insert function prototypes +// Please do not delete /**************************************/ // BINDING_FUNCTION_PROTOTYPES( void bind_sink(py::module& m); @@ -50,9 +50,9 @@ PYBIND11_MODULE(osmosdr_python, m) py::module::import("gnuradio.gr"); /**************************************/ - /* The following comment block is used for - /* gr_modtool to insert binding function calls - /* Please do not delete + // The following comment block is used for + // gr_modtool to insert binding function calls + // Please do not delete /**************************************/ // BINDING_FUNCTION_CALLS( bind_sink(m); diff --git a/python/bindings/source_python.cc b/python/bindings/source_python.cc index 48bf10c..0cab394 100644 --- a/python/bindings/source_python.cc +++ b/python/bindings/source_python.cc @@ -14,7 +14,7 @@ /* BINDTOOL_GEN_AUTOMATIC(1) */ /* BINDTOOL_USE_PYGCCXML(0) */ /* BINDTOOL_HEADER_FILE(source.h) */ -/* BINDTOOL_HEADER_FILE_HASH(574373c3c7682569b0fd7eea577739da) */ +/* BINDTOOL_HEADER_FILE_HASH(d1a3d9ea3d815fe4f18acc3eef21f1b6) */ /***********************************************************************************/ #include