docs: adding uhd Doxygen documentation page and README file.

9 files changed, 91 insertions, 1 deletions

diff --git a/gr-uhd/Makefile.am b/gr-uhd/Makefile.am
index c81a1a049..56829e9c4 100644
--- a/gr-uhd/Makefile.am
+++ b/gr-uhd/Makefile.am
@@ -21,7 +21,7 @@
 
 include $(top_srcdir)/Makefile.common
 
-SUBDIRS = include lib apps examples
+SUBDIRS = include lib apps examples doc
 
 if PYTHON
 SUBDIRS += swig grc
diff --git a/gr-uhd/doc/.gitignore b/gr-uhd/doc/.gitignore
new file mode 100644
index 000000000..b336cc7ce
--- /dev/null
+++ b/gr-uhd/doc/.gitignore
@@ -0,0 +1,2 @@
+/Makefile
+/Makefile.in
diff --git a/gr-uhd/doc/Makefile.am b/gr-uhd/doc/Makefile.am
new file mode 100644
index 000000000..eee3ebcf6
--- /dev/null
+++ b/gr-uhd/doc/Makefile.am
@@ -0,0 +1,27 @@
+#
+# Copyright 2011 Free Software Foundation, Inc.
+# 
+# This file is part of GNU Radio
+# 
+# GNU Radio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3, or (at your option)
+# any later version.
+# 
+# GNU Radio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with GNU Radio; see the file COPYING.  If not, write to
+# the Free Software Foundation, Inc., 51 Franklin Street,
+# Boston, MA 02110-1301, USA.
+# 
+
+include $(top_srcdir)/Makefile.common
+
+SUBDIRS =
+
+dist_gr_doc_DATA =		\
+	README.uhd
diff --git a/gr-uhd/doc/README.uhd b/gr-uhd/doc/README.uhd
new file mode 100644
index 000000000..ec8024c09
--- /dev/null
+++ b/gr-uhd/doc/README.uhd
@@ -0,0 +1,14 @@
+This is the GNU Radio UHD package. It is the interface to the UHD
+library to connect to and send and receive data between the Ettus
+Research, LLC product line. To use the UHD blocks, the Python
+namespaces is in gnuradio.uhd, which would be normally imported
+as:
+
+    from gnuradio import uhd
+
+See the Doxygen documentation for details about the blocks available
+in this package. A quick listing of the details can be found in Python
+after importing by using: 
+
+    help(uhd)
+
diff --git a/gr-uhd/doc/uhd.dox b/gr-uhd/doc/uhd.dox
new file mode 100644
index 000000000..f08fe2f06
--- /dev/null
+++ b/gr-uhd/doc/uhd.dox
@@ -0,0 +1,35 @@
+/*! \page page_uhd UHD Interface
+
+\section Introduction
+This is the GNU Radio UHD package. It is the interface to the UHD
+library to connect to and send and receive data between the Ettus
+Research, LLC product line. To use the UHD blocks, the Python
+namespaces is in gnuradio.uhd, which would be normally imported
+as:
+
+\code
+    from gnuradio import uhd
+\endcode
+
+The relevant blocks are listed in the \ref uhd_blk group.
+
+A quick listing of the details can be found in Python after importing
+by using:
+
+\code
+    help(uhd)
+\endcode
+
+
+\section External Documentation
+
+Ettus Research keeps the comprehensive documentation to the underlying UHD driver, which can be found:
+
+    http://files.ettus.com/uhd_docs/manual/html/
+
+The UHD Doxygen page is located:
+
+    http://files.ettus.com/uhd_docs/doxygen/html/index.html
+
+
+*/
diff --git a/gr-uhd/include/gr_uhd_amsg_source.h b/gr-uhd/include/gr_uhd_amsg_source.h
index bc0feb438..accf15ce2 100644
--- a/gr-uhd/include/gr_uhd_amsg_source.h
+++ b/gr-uhd/include/gr_uhd_amsg_source.h
@@ -28,6 +28,10 @@
 
 class uhd_amsg_source;
 
+/*!
+ * \brief Make a new USRP asynchronous message-based source block.
+ * \ingroup uhd_blk
+ */
 GR_UHD_API boost::shared_ptr<uhd_amsg_source> uhd_make_amsg_source(
     const uhd::device_addr_t &device_addr,
     gr_msg_queue_sptr msgq
diff --git a/gr-uhd/include/gr_uhd_usrp_sink.h b/gr-uhd/include/gr_uhd_usrp_sink.h
index c1fc3b09e..f11d00063 100644
--- a/gr-uhd/include/gr_uhd_usrp_sink.h
+++ b/gr-uhd/include/gr_uhd_usrp_sink.h
@@ -30,6 +30,7 @@ class uhd_usrp_sink;
 
 /*!
  * \brief Make a new USRP sink block.
+ * \ingroup uhd_blk
  *
  * The USRP sink block reads a stream and transmits the samples.
  * The sink block also provides API calls for transmitter settings.
diff --git a/gr-uhd/include/gr_uhd_usrp_source.h b/gr-uhd/include/gr_uhd_usrp_source.h
index f8ac9361e..fecc6e94d 100644
--- a/gr-uhd/include/gr_uhd_usrp_source.h
+++ b/gr-uhd/include/gr_uhd_usrp_source.h
@@ -30,6 +30,7 @@ class uhd_usrp_source;
 
 /*!
  * \brief Make a new USRP source block.
+ * \ingroup uhd_blk
  *
  * The USRP source block receives samples and writes to a stream.
  * The source block also provides API calls for receiver settings.
diff --git a/gr-uhd/swig/__init__.py b/gr-uhd/swig/__init__.py
index 1f82b4a26..c63d3cc57 100644
--- a/gr-uhd/swig/__init__.py
+++ b/gr-uhd/swig/__init__.py
@@ -19,6 +19,12 @@
 # Boston, MA 02110-1301, USA.
 #
 
+'''
+This is the GNU Radio UHD package. It is the interface to the UHD
+library to connect to and send and receive data between the Ettus
+Research, LLC product line.
+'''
+
 ########################################################################
 # Prepare uhd swig module to make it more pythonic
 ########################################################################