Doc fixes from Firas.

git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@7504 221aa14e-8319-0410-a670-987f0aec2ac5

26 files changed, 28 insertions, 6 deletions

diff --git a/gnuradio-core/src/lib/runtime/gr_basic_block.h b/gnuradio-core/src/lib/runtime/gr_basic_block.h
index b2b8b42a3..8dc965da7 100644
--- a/gnuradio-core/src/lib/runtime/gr_basic_block.h
+++ b/gnuradio-core/src/lib/runtime/gr_basic_block.h
@@ -29,7 +29,7 @@
 
 /*!
  * \brief The abstract base class for all signal processing blocks.
- * \ingroup block
+ * \ingroup base
  *
  * Basic blocks are the bare abstraction of an entity that has a name
  * and a set of inputs and outputs.  These are never instantiated
diff --git a/gnuradio-core/src/lib/runtime/gr_block.h b/gnuradio-core/src/lib/runtime/gr_block.h
index ce58ca9ac..79237ee83 100644
--- a/gnuradio-core/src/lib/runtime/gr_block.h
+++ b/gnuradio-core/src/lib/runtime/gr_block.h
@@ -27,7 +27,7 @@
 
 /*!
  * \brief The abstract base class for all 'terminal' processing blocks.
- * \ingroup block
+ * \ingroup base
  *
  * A signal processing flow is constructed by creating a tree of 
  * hierarchical blocks, which at any level may also contain terminal nodes
diff --git a/gnuradio-core/src/lib/runtime/gr_dispatcher.h b/gnuradio-core/src/lib/runtime/gr_dispatcher.h
index acfc428a2..34f825102 100644
--- a/gnuradio-core/src/lib/runtime/gr_dispatcher.h
+++ b/gnuradio-core/src/lib/runtime/gr_dispatcher.h
@@ -34,6 +34,7 @@ gr_dispatcher_sptr gr_make_dispatcher();
 
 /*!
  * \brief invoke callbacks based on select.
+ * \ingroup internal
  *
  * \sa gr_select_handler
  */
diff --git a/gnuradio-core/src/lib/runtime/gr_error_handler.h b/gnuradio-core/src/lib/runtime/gr_error_handler.h
index eb69fccb5..530a2c23c 100644
--- a/gnuradio-core/src/lib/runtime/gr_error_handler.h
+++ b/gnuradio-core/src/lib/runtime/gr_error_handler.h
@@ -48,6 +48,7 @@
 
 /*!
  * \brief abstract error handler
+ * \ingroup base
  */
 class gr_error_handler {
 public:
diff --git a/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h b/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h
index 0f4928064..10c5d6416 100644
--- a/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h
+++ b/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h
@@ -36,6 +36,7 @@ gr_flat_flowgraph_sptr gr_make_flat_flowgraph();
 /*!
  *\brief Class specializing gr_flat_flowgraph that has all nodes
  * as gr_blocks, with no hierarchy
+ * \ingroup base
  *
  */
 class gr_flat_flowgraph : public gr_flowgraph
diff --git a/gnuradio-core/src/lib/runtime/gr_flowgraph.h b/gnuradio-core/src/lib/runtime/gr_flowgraph.h
index 131e41bb9..c97a50782 100644
--- a/gnuradio-core/src/lib/runtime/gr_flowgraph.h
+++ b/gnuradio-core/src/lib/runtime/gr_flowgraph.h
@@ -28,6 +28,7 @@
 
 /*!
  *\brief Class representing a specific input or output graph endpoint
+ * \ingroup internal
  *
  */
 class gr_endpoint
diff --git a/gnuradio-core/src/lib/runtime/gr_hier_block2.h b/gnuradio-core/src/lib/runtime/gr_hier_block2.h
index 6124e4d51..d04acb970 100644
--- a/gnuradio-core/src/lib/runtime/gr_hier_block2.h
+++ b/gnuradio-core/src/lib/runtime/gr_hier_block2.h
@@ -26,6 +26,7 @@
 
 /*!
  * \brief public constructor for gr_hier_block2
+
  */
 gr_hier_block2_sptr gr_make_hier_block2(const std::string &name,
                                         gr_io_signature_sptr input_signature,
@@ -35,6 +36,7 @@ class gr_hier_block2_detail;
 
 /*!
  * \brief gr_hier_block2 - Hierarchical container class for gr_block's
+ * \ingroup internal
  *
  */
 class gr_hier_block2 : public gr_basic_block
diff --git a/gnuradio-core/src/lib/runtime/gr_io_signature.h b/gnuradio-core/src/lib/runtime/gr_io_signature.h
index aa839ad0c..bf71dea57 100644
--- a/gnuradio-core/src/lib/runtime/gr_io_signature.h
+++ b/gnuradio-core/src/lib/runtime/gr_io_signature.h
@@ -28,6 +28,7 @@
 /*!
  * \brief Create an i/o signature
  *
+ * \ingroup internal
  * \param min_streams  specify minimum number of streams (>= 0)
  * \param max_streams  specify maximum number of streams (>= min_streams or -1 -> infinite)
  * \param sizeof_stream_item  specify the size of the items in each stream
diff --git a/gnuradio-core/src/lib/runtime/gr_local_sighandler.h b/gnuradio-core/src/lib/runtime/gr_local_sighandler.h
index c753f0ff5..6b60cf09a 100644
--- a/gnuradio-core/src/lib/runtime/gr_local_sighandler.h
+++ b/gnuradio-core/src/lib/runtime/gr_local_sighandler.h
@@ -32,6 +32,7 @@
 /*!
  * \brief Get and set signal handler.
  *
+ * \ingroup internal
  * Constructor installs new handler, destructor reinstalls
  * original value.
  */
diff --git a/gnuradio-core/src/lib/runtime/gr_message.h b/gnuradio-core/src/lib/runtime/gr_message.h
index e3c52a581..179f7d9bc 100644
--- a/gnuradio-core/src/lib/runtime/gr_message.h
+++ b/gnuradio-core/src/lib/runtime/gr_message.h
@@ -38,8 +38,9 @@ gr_message_sptr
 gr_make_message_from_string(const std::string s, long type = 0, double arg1 = 0, double arg2 = 0);
 
 /*!
- * \brief Message.
+ * \brief Message class.
  *
+ * \ingroup misc
  * The ideas and method names for adjustable message length were
  * lifted from the click modular router "Packet" class.
  */
diff --git a/gnuradio-core/src/lib/runtime/gr_msg_handler.h b/gnuradio-core/src/lib/runtime/gr_msg_handler.h
index 443611841..774dce73e 100644
--- a/gnuradio-core/src/lib/runtime/gr_msg_handler.h
+++ b/gnuradio-core/src/lib/runtime/gr_msg_handler.h
@@ -29,6 +29,7 @@ typedef boost::shared_ptr<gr_msg_handler> gr_msg_handler_sptr;
 
 /*!
  * \brief abstract class of message handlers
+ * \ingroup base
  */
 class gr_msg_handler {
 public:
diff --git a/gnuradio-core/src/lib/runtime/gr_msg_queue.h b/gnuradio-core/src/lib/runtime/gr_msg_queue.h
index fc4c2407f..38556b3ca 100644
--- a/gnuradio-core/src/lib/runtime/gr_msg_queue.h
+++ b/gnuradio-core/src/lib/runtime/gr_msg_queue.h
@@ -32,6 +32,7 @@ gr_msg_queue_sptr gr_make_msg_queue(unsigned int limit=0);
 
 /*!
  * \brief thread-safe message queue
+ * \ingroup misc
  */
 class gr_msg_queue : public gr_msg_handler {
   omni_mutex		d_mutex;
diff --git a/gnuradio-core/src/lib/runtime/gr_realtime.h b/gnuradio-core/src/lib/runtime/gr_realtime.h
index 49a52a0d5..cf0423aaa 100644
--- a/gnuradio-core/src/lib/runtime/gr_realtime.h
+++ b/gnuradio-core/src/lib/runtime/gr_realtime.h
@@ -32,6 +32,7 @@ typedef enum {
 
 /*!
  * \brief If possible, enable high-priority "real time" scheduling.
+ * \ingroup misc
  */
 gr_rt_status_t
 gr_enable_realtime_scheduling();
diff --git a/gnuradio-core/src/lib/runtime/gr_scheduler_thread.h b/gnuradio-core/src/lib/runtime/gr_scheduler_thread.h
index c989f797c..89daba403 100644
--- a/gnuradio-core/src/lib/runtime/gr_scheduler_thread.h
+++ b/gnuradio-core/src/lib/runtime/gr_scheduler_thread.h
@@ -35,6 +35,7 @@ typedef gr_scheduler_thread_vector_t::iterator gr_scheduler_thread_viter_t;
 /*!
  *\brief A single thread of execution for the scheduler
  *
+ * \ingroup internal
  * This class implements a single thread that runs undetached, and
  * invokes the single-threaded block scheduler.  The runtime makes
  * one of these for each distinct partition of a flowgraph and runs
diff --git a/gnuradio-core/src/lib/runtime/gr_select_handler.h b/gnuradio-core/src/lib/runtime/gr_select_handler.h
index cc883dc90..c3808995b 100644
--- a/gnuradio-core/src/lib/runtime/gr_select_handler.h
+++ b/gnuradio-core/src/lib/runtime/gr_select_handler.h
@@ -31,6 +31,7 @@ typedef boost::shared_ptr<gr_select_handler> gr_select_handler_sptr;
 
 /*!
  * \brief Abstract handler for select based notification.
+ * \ingroup base
  *
  * \sa gr_dispatcher
  */
diff --git a/gnuradio-core/src/lib/runtime/gr_sync_block.h b/gnuradio-core/src/lib/runtime/gr_sync_block.h
index dcc7e2e73..c7f7d4df3 100644
--- a/gnuradio-core/src/lib/runtime/gr_sync_block.h
+++ b/gnuradio-core/src/lib/runtime/gr_sync_block.h
@@ -27,7 +27,7 @@
 
 /*!
  * \brief synchronous 1:1 input to output with history
- * \ingroup block
+ * \ingroup internal
  *
  * Override work to provide the signal processing implementation.
  */
diff --git a/gnuradio-core/src/lib/runtime/gr_sync_decimator.h b/gnuradio-core/src/lib/runtime/gr_sync_decimator.h
index 4666ece8e..1482ecc00 100644
--- a/gnuradio-core/src/lib/runtime/gr_sync_decimator.h
+++ b/gnuradio-core/src/lib/runtime/gr_sync_decimator.h
@@ -27,7 +27,7 @@
 
 /*!
  * \brief synchronous N:1 input to output with history
- * \ingroup block
+ * \ingroup internal
  *
  * Override work to provide the signal processing implementation.
  */
diff --git a/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h b/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h
index 46851de2d..b5dfed70c 100644
--- a/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h
+++ b/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h
@@ -27,7 +27,7 @@
 
 /*!
  * \brief synchronous 1:N input to output with history
- * \ingroup block
+ * \ingroup internal
  *
  * Override work to provide the signal processing implementation.
  */
diff --git a/gnuradio-core/src/lib/runtime/gr_timer.h b/gnuradio-core/src/lib/runtime/gr_timer.h
index 2e1106037..ff14e315d 100644
--- a/gnuradio-core/src/lib/runtime/gr_timer.h
+++ b/gnuradio-core/src/lib/runtime/gr_timer.h
@@ -33,6 +33,7 @@ typedef void (*gr_timer_hook)(gr_timer *, void *);
 /*!
  * \brief create a timeout.
  *
+ * \ingroup misc
  * gr_timer_hook is called when timer fires.
  */
 gr_timer_sptr gr_make_timer (gr_timer_hook, void *);
diff --git a/gnuradio-core/src/lib/runtime/gr_top_block.h b/gnuradio-core/src/lib/runtime/gr_top_block.h
index 57c36ad3b..28814a9a0 100644
--- a/gnuradio-core/src/lib/runtime/gr_top_block.h
+++ b/gnuradio-core/src/lib/runtime/gr_top_block.h
@@ -31,6 +31,7 @@ gr_top_block_sptr gr_make_top_block(const std::string &name);
 
 /*!
  *\brief Top-level hierarchical block representing a flowgraph
+ * \ingroup internal
  *
  */
 class gr_top_block : public gr_hier_block2
diff --git a/gnuradio-core/src/lib/runtime/gr_top_block_impl.h b/gnuradio-core/src/lib/runtime/gr_top_block_impl.h
index 00cb7f979..1868cffd6 100644
--- a/gnuradio-core/src/lib/runtime/gr_top_block_impl.h
+++ b/gnuradio-core/src/lib/runtime/gr_top_block_impl.h
@@ -28,6 +28,7 @@
 /*!
  *\brief Implementation details of gr_top_block
  *
+ * \ingroup internal
  * The actual implementation of gr_top_block. Separate class allows
  * decoupling of changes from dependent classes.
  *
diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h
index c224b7852..0d4f45832 100644
--- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h
+++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h
@@ -27,6 +27,7 @@
 
 /*!
  * \brief abstract class to implement doubly mapped virtual memory circular buffers
+ * \ingroup base
  */
 class gr_vmcircbuf {
  protected:
diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h
index c866e80e8..2bb7bb16f 100644
--- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h
+++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h
@@ -30,6 +30,7 @@
 #endif
 /*!
  * \brief concrete class to implement circular buffers with mmap and shm_open
+ * \ingroup base
  */
 class gr_vmcircbuf_createfilemapping : public gr_vmcircbuf
 {
diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h
index 1444a68d7..7e628fa59 100644
--- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h
+++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h
@@ -27,6 +27,7 @@
 
 /*!
  * \brief concrete class to implement circular buffers with mmap and shm_open
+ * \ingroup base
  */
 class gr_vmcircbuf_mmap_shm_open : public gr_vmcircbuf {
  public:
diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h
index 5c84dd69a..da91d2f02 100644
--- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h
+++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h
@@ -27,6 +27,7 @@
 
 /*!
  * \brief concrete class to implement circular buffers with mmap and shm_open
+ * \ingroup base
  */
 class gr_vmcircbuf_mmap_tmpfile : public gr_vmcircbuf {
  public:
diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h
index d5f739ae4..ffc74918e 100644
--- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h
+++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h
@@ -27,6 +27,7 @@
 
 /*!
  * \brief concrete class to implement circular buffers with mmap and shm_open
+ * \ingroup base
  */
 class gr_vmcircbuf_sysv_shm : public gr_vmcircbuf {
  public: