summaryrefslogtreecommitdiff
path: root/mblock/src
diff options
context:
space:
mode:
authoreb <eb@221aa14e-8319-0410-a670-987f0aec2ac5>2009-05-14 18:29:26 +0000
committereb <eb@221aa14e-8319-0410-a670-987f0aec2ac5>2009-05-14 18:29:26 +0000
commit349331a884594a9e242231bffb03112b8943883c (patch)
tree9d765ce9484f84eeb95e74facb1c522dd1ff90e2 /mblock/src
parent18f685853b2bf1914148cb07a9c6df76f5063ff3 (diff)
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
Diffstat (limited to 'mblock/src')
-rw-r--r--mblock/src/include/mblock/mblock.h2
-rw-r--r--mblock/src/include/mblock/port.h2
-rw-r--r--mblock/src/lib/mb_mblock_impl.h2
-rw-r--r--mblock/src/lib/mb_port_simple.h2
-rw-r--r--mblock/src/lib/mb_runtime_base.h4
-rw-r--r--mblock/src/lib/mb_runtime_thread_per_block.h2
-rw-r--r--mblock/src/lib/mb_worker.h2
7 files changed, 8 insertions, 8 deletions
diff --git a/mblock/src/include/mblock/mblock.h b/mblock/src/include/mblock/mblock.h
index 14517ffcc5..bbc40f1ef5 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 892a1dd976..782bb1285a 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 ed8059b008..9914579124 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 3041239adf..87b7654b0d 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 b88a9ca4e9..98b5f3e0a8 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 ef962911e1..185ed32b5b 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 9831de9260..59d12545ca 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
{