[Commit-gnuradio] r9239 - gnuradio/branches/features/mp-sched/gnuradio-core/src/lib/runtime

[eb]

Author: eb
Date: 2008-08-11 16:16:13 -0600 (Mon, 11 Aug 2008)
New Revision: 9239

Modified:
   gnuradio/branches/features/mp-sched/gnuradio-core/src/lib/runtime/gr_buffer.h
Log:
doc fix.  Thanks Martin.

Modified: 
gnuradio/branches/features/mp-sched/gnuradio-core/src/lib/runtime/gr_buffer.h
===================================================================
--- 
gnuradio/branches/features/mp-sched/gnuradio-core/src/lib/runtime/gr_buffer.h   
    2008-08-11 21:59:08 UTC (rev 9238)
+++ 
gnuradio/branches/features/mp-sched/gnuradio-core/src/lib/runtime/gr_buffer.h   
    2008-08-11 22:16:13 UTC (rev 9239)
@@ -38,7 +38,7 @@
  *
  * \param nitems is the minimum number of items the buffer will hold.
  * \param sizeof_item is the size of an item in bytes.
- * \param link is the buffer that writes to this buffer.
+ * \param link is the block that writes to this buffer.
  */
 gr_buffer_sptr gr_make_buffer (int nitems, size_t sizeof_item, gr_block_sptr 
link=gr_block_sptr());
 
@@ -81,7 +81,7 @@
   bool done () const { return d_done; }
 
   /*!
-   * \brief Return the block that writes this buffer.
+   * \brief Return the block that writes to this buffer.
    */
   gr_block_sptr link() { return gr_block_sptr(d_link); }
 
@@ -105,7 +105,7 @@
   gr_vmcircbuf                        *d_vmcircbuf;
   size_t                               d_sizeof_item;  // in bytes
   std::vector<gr_buffer_reader *>      d_readers;
-  boost::weak_ptr<gr_block>            d_link;         // block that writes 
this buffer
+  boost::weak_ptr<gr_block>            d_link;         // block that writes to 
this buffer
 
   //
   // The mutex protects d_write_index, d_done and the d_read_index's in the 
buffer readers.
@@ -147,7 +147,7 @@
    *
    * \param nitems is the minimum number of items the buffer will hold.
    * \param sizeof_item is the size of an item in bytes.
-   * \param link is the buffer that writes to this buffer.
+   * \param link is the block that writes to this buffer.
    *
    * The total size of the buffer will be rounded up to a system
    * dependent boundary.  This is typically the system page size, but
@@ -165,7 +165,7 @@
 /*!
  * \brief create a new gr_buffer_reader and attach it to buffer \p buf
  * \param nzero_preload -- number of zero items to "preload" into buffer.
- * \param link is the buffer that reads using this gr_buffer_reader.
+ * \param link is the block that reads from the buffer using this 
gr_buffer_reader.
  */
 gr_buffer_reader_sptr 
 gr_buffer_add_reader (gr_buffer_sptr buf, int nzero_preload, gr_block_sptr 
link=gr_block_sptr());