From 349331a884594a9e242231bffb03112b8943883c Mon Sep 17 00:00:00 2001
From: eb
Date: Thu, 14 May 2009 18:29:26 +0000
Subject: Doc fixes.  Merged eb/t367 -r11020:11025 to trunk.  This changeset
 moves the primary doxygen configuration under the top-level docs directory. 
 It creates a new "docs" top-level component that can be enabled/disabled
 using the configure --disable-docs option.  At this time, the
 --enable-doxygen option is still required to enable the generation of the
 doxygen documents.  I think the flag should probably be removed, and default
 to "yes" if we find doxygen on the path.  The user can disable the doc
 generation using --disable-docs if desired.

The doxygen config file has been modified such that doxygen is now
only run on the C++ sources.  No attempt is made to process the python
code using doxygen.  This results in a less confusing set of docs for
the the C++ API.  Straightening out the python docs is left for later.

Many classes are currently misclassified (\ingroup <wrong>).  That
will probably require another day of work, that I can't get to right now.



git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11027 221aa14e-8319-0410-a670-987f0aec2ac5
---
 mblock/src/include/mblock/mblock.h           | 2 +-
 mblock/src/include/mblock/port.h             | 2 +-
 mblock/src/lib/mb_mblock_impl.h              | 2 +-
 mblock/src/lib/mb_port_simple.h              | 2 +-
 mblock/src/lib/mb_runtime_base.h             | 4 ++--
 mblock/src/lib/mb_runtime_thread_per_block.h | 2 +-
 mblock/src/lib/mb_worker.h                   | 2 +-
 7 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'mblock')

diff --git a/mblock/src/include/mblock/mblock.h b/mblock/src/include/mblock/mblock.h
index 14517ffcc..bbc40f1ef 100644
--- a/mblock/src/include/mblock/mblock.h
+++ b/mblock/src/include/mblock/mblock.h
@@ -307,7 +307,7 @@ public:
   walk_tree(mb_visitor *visitor);
 
 
-  //! \implementation
+  //! \internal
   // internal use only
   mb_mblock_impl_sptr
   impl() const { return d_impl; }
diff --git a/mblock/src/include/mblock/port.h b/mblock/src/include/mblock/port.h
index 892a1dd97..782bb1285 100644
--- a/mblock/src/include/mblock/port.h
+++ b/mblock/src/include/mblock/port.h
@@ -85,7 +85,7 @@ public:
 
   /*
    * \brief Invalidate any cached peer resolutions
-   * \implementation
+   * \internal
    */
   virtual void invalidate_cache() = 0;
 };
diff --git a/mblock/src/lib/mb_mblock_impl.h b/mblock/src/lib/mb_mblock_impl.h
index ed8059b00..991457912 100644
--- a/mblock/src/lib/mb_mblock_impl.h
+++ b/mblock/src/lib/mb_mblock_impl.h
@@ -216,7 +216,7 @@ private:
 
   /*!
    * \brief walk mblock tree and invalidate all port resolution caches.
-   * \implementation
+   * \internal
    */
   void
   invalidate_all_port_caches();
diff --git a/mblock/src/lib/mb_port_simple.h b/mblock/src/lib/mb_port_simple.h
index 3041239ad..87b7654b0 100644
--- a/mblock/src/lib/mb_port_simple.h
+++ b/mblock/src/lib/mb_port_simple.h
@@ -63,7 +63,7 @@ public:
 
   /*
    * \brief Invalidate any cached peer resolutions
-   * \implementation
+   * \internal
    */
   void invalidate_cache();
 
diff --git a/mblock/src/lib/mb_runtime_base.h b/mblock/src/lib/mb_runtime_base.h
index b88a9ca4e..98b5f3e0a 100644
--- a/mblock/src/lib/mb_runtime_base.h
+++ b/mblock/src/lib/mb_runtime_base.h
@@ -40,13 +40,13 @@ public:
 
   /*!
    * \brief lock the big runtime lock
-   * \implementation
+   * \internal
    */
   inline void lock() { d_brl.lock(); }
 
   /*!
    * \brief unlock the big runtime lock
-   * \implementation
+   * \internal
    */
   inline void unlock() { d_brl.unlock(); }
 
diff --git a/mblock/src/lib/mb_runtime_thread_per_block.h b/mblock/src/lib/mb_runtime_thread_per_block.h
index ef962911e..185ed32b5 100644
--- a/mblock/src/lib/mb_runtime_thread_per_block.h
+++ b/mblock/src/lib/mb_runtime_thread_per_block.h
@@ -28,7 +28,7 @@
 
 /*!
  * \brief Concrete runtime that uses a thread per mblock
- * \implementation
+ * \internal
  *
  * These are all implementation details.
  */
diff --git a/mblock/src/lib/mb_worker.h b/mblock/src/lib/mb_worker.h
index 9831de926..59d12545c 100644
--- a/mblock/src/lib/mb_worker.h
+++ b/mblock/src/lib/mb_worker.h
@@ -34,7 +34,7 @@ class mb_runtime_thread_per_block;
 
 /*!
  * \brief Worker thread for thread_per_block runtime
- * \implementation
+ * \internal
  */
 class mb_worker : public omni_thread
 {
-- 
cgit