From ed236703145cb56e7e69c5605c5fbf01a1ab3878 Mon Sep 17 00:00:00 2001
From: eb
Date: Fri, 22 May 2009 16:11:15 +0000
Subject: doc fixes!  work-in-progress

git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11085 221aa14e-8319-0410-a670-987f0aec2ac5
---
 usrp2/host/include/usrp2/metadata.h          | 2 ++
 usrp2/host/include/usrp2/rx_nop_handler.h    | 2 ++
 usrp2/host/include/usrp2/rx_sample_handler.h | 1 +
 usrp2/host/include/usrp2/tune_result.h       | 3 +++
 usrp2/host/include/usrp2/usrp2.h             | 4 ++++
 usrp2/host/lib/eth_buffer.cc                 | 2 +-
 6 files changed, 13 insertions(+), 1 deletion(-)

(limited to 'usrp2')

diff --git a/usrp2/host/include/usrp2/metadata.h b/usrp2/host/include/usrp2/metadata.h
index 52efd07ef..8a95c3859 100644
--- a/usrp2/host/include/usrp2/metadata.h
+++ b/usrp2/host/include/usrp2/metadata.h
@@ -27,6 +27,7 @@ namespace usrp2 {
 
   /*!
    * \brief metadata associated with received frames
+   * \ingroup usrp2
    */
   struct rx_metadata {
     uint32_t		word0;			//< debugging, extensions
@@ -43,6 +44,7 @@ namespace usrp2 {
 
   /*!
    * \brief metadata associated with transmitted frames
+   * \ingroup usrp2
    */
   struct tx_metadata {
     fpga_timestamp	timestamp;		//< time to transmit first sample of frame
diff --git a/usrp2/host/include/usrp2/rx_nop_handler.h b/usrp2/host/include/usrp2/rx_nop_handler.h
index 44ca51398..68a254f31 100644
--- a/usrp2/host/include/usrp2/rx_nop_handler.h
+++ b/usrp2/host/include/usrp2/rx_nop_handler.h
@@ -23,6 +23,8 @@
 #include <boost/shared_ptr.hpp>
 
 /*!
+ * \ingroup usrp2
+ *
  * Base class for receive handlers that must copy into potentially limited
  * range destination buffers.
  *
diff --git a/usrp2/host/include/usrp2/rx_sample_handler.h b/usrp2/host/include/usrp2/rx_sample_handler.h
index 480cbc4f8..a7fb7b641 100644
--- a/usrp2/host/include/usrp2/rx_sample_handler.h
+++ b/usrp2/host/include/usrp2/rx_sample_handler.h
@@ -26,6 +26,7 @@ namespace usrp2 {
 
   /*!
    * \brief Abstract function object called to handle received data blocks.
+   * \ingroup usrp2
    *
    * An object derived from this class is passed to usrp2::rx_samples
    * to process the received frames of samples.
diff --git a/usrp2/host/include/usrp2/tune_result.h b/usrp2/host/include/usrp2/tune_result.h
index 9075596f4..9fe6539da 100644
--- a/usrp2/host/include/usrp2/tune_result.h
+++ b/usrp2/host/include/usrp2/tune_result.h
@@ -21,6 +21,9 @@
 
 namespace usrp2 {
 
+  /*
+   * \ingroup usrp2
+   */
   class tune_result
   {
   public:
diff --git a/usrp2/host/include/usrp2/usrp2.h b/usrp2/host/include/usrp2/usrp2.h
index 1c99a54cb..af1297b9a 100644
--- a/usrp2/host/include/usrp2/usrp2.h
+++ b/usrp2/host/include/usrp2/usrp2.h
@@ -68,6 +68,10 @@ namespace usrp2 {
   static const int GPIO_TX_BANK = 0;
   static const int GPIO_RX_BANK = 1;
 
+  /*!
+   * \brief standard C++ interface to USRP2
+   * \ingroup usrp2
+   */
   class usrp2 : boost::noncopyable
   {
   public:
diff --git a/usrp2/host/lib/eth_buffer.cc b/usrp2/host/lib/eth_buffer.cc
index 1042868f3..4c346c292 100644
--- a/usrp2/host/lib/eth_buffer.cc
+++ b/usrp2/host/lib/eth_buffer.cc
@@ -1,6 +1,6 @@
 /* -*- c++ -*- */
 /*
- * Copyright 2008 Free Software Foundation, Inc.
+ * Copyright 2008,2009 Free Software Foundation, Inc.
  * 
  * This file is part of GNU Radio
  * 
-- 
cgit