[Commit-gnuradio] r4433 - gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io

[trondeau]

Author: trondeau
Date: 2007-02-08 10:20:29 -0700 (Thu, 08 Feb 2007)
New Revision: 4433

Modified:
   
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.h
   
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.h
Log:
improved Doxygen formatting

Modified: 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.h
===================================================================
--- 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.h
    2007-02-08 16:50:50 UTC (rev 4432)
+++ 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_sink.h
    2007-02-08 17:20:29 UTC (rev 4433)
@@ -31,8 +31,14 @@
 class gr_udp_sink;
 typedef boost::shared_ptr<gr_udp_sink> gr_udp_sink_sptr;
 
+gr_udp_sink_sptr
+gr_make_udp_sink (size_t itemsize, 
+                 const char *src, unsigned short port_src,
+                 const char *dst, unsigned short port_dst,
+                 int payload_size=1472);
+
 /*!
- * \brief Write stream to an UDP port (over UDP).
+ * \brief Write stream to an UDP socket.
  * \ingroup sink
  * 
  * \param itemsize     The size (in bytes) of the item datatype
@@ -46,12 +52,6 @@
  *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP 
header))
  */
 
-gr_udp_sink_sptr
-gr_make_udp_sink (size_t itemsize, 
-                 const char *src, unsigned short port_src,
-                 const char *dst, unsigned short port_dst,
-                 int payload_size=1472);
-
 class gr_udp_sink : public gr_sync_block
 {
   friend gr_udp_sink_sptr gr_make_udp_sink (size_t itemsize, 
@@ -74,6 +74,19 @@
   sockaddr_in    d_sockaddr_dst;    // store the destination sockaddr data 
(formatted IP address and port number)
 
  protected:
+  /*!
+   * \brief UDP Sink Constructor
+   * 
+   * \param itemsize     The size (in bytes) of the item datatype
+   * \param src          The source address as either the host name or the 
'numbers-and-dots'
+   *                     IP address
+   * \param port_src     Destination port to bind to (0 allows socket to 
choose an appropriate port)
+   * \param dst          The destination address as either the host name or 
the 'numbers-and-dots'
+   *                     IP address
+   * \param port_dst     Destination port to connect to
+   * \param payload_size UDP payload size by default set to 
+   *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP 
header))
+   */
   gr_udp_sink (size_t itemsize, 
               const char *ipaddrl, unsigned short portl,
               const char *ipaddrr, unsigned short portr,

Modified: 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.h
===================================================================
--- 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.h
  2007-02-08 16:50:50 UTC (rev 4432)
+++ 
gnuradio/branches/developers/trondeau/udp/gnuradio-core/src/lib/io/gr_udp_source.h
  2007-02-08 17:20:29 UTC (rev 4433)
@@ -31,19 +31,21 @@
 class gr_udp_source;
 typedef boost::shared_ptr<gr_udp_source> gr_udp_source_sptr;
 
-/*!
- * \brief Write stream to an UDP port (over UDP).
+gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *src, 
+                                     unsigned short port_src, int 
payload_size=1472);
+
+/*! 
+ * \brief Read stream from an UDP socket.
  * \ingroup sink
- * 
+ *
+ * \param itemsize     The size (in bytes) of the item datatype
  * \param src          The source address as either the host name or the 
'numbers-and-dots'
  *                     IP address
  * \param port_src     The port number on which the socket listens for data
  * \param payload_size UDP payload size by default set to 
  *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP 
header))
  */
- 
-gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *src, 
-                                     unsigned short port_src, int 
payload_size=1472);
+*/
 
 class gr_udp_source : public gr_sync_block
 {
@@ -67,6 +69,16 @@
   size_t d_temp_offset; // point to temp buffer location offset
 
  protected:
+  /*!
+   * \brief UDP Source Constructor
+   * 
+   * \param itemsize     The size (in bytes) of the item datatype
+   * \param src          The source address as either the host name or the 
'numbers-and-dots'
+   *                     IP address
+   * \param port_src     The port number on which the socket listens for data
+   * \param payload_size UDP payload size by default set to 
+   *                     1472 = (1500 MTU - (8 byte UDP header) - (20 byte IP 
header))
+   */
   gr_udp_source(size_t itemsize, const char *src, unsigned short port_src, int 
payload_size);
 
  public: