From: pug <pug@270642c3-0616-0410-b53a-bc976706d245>
Date: Wed, 13 Feb 2008 14:12:14 +0000 (+0000)
Subject: fixed documentation for mcLoop
X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=442eaa6a2f502c7b56f0127f61acf9ffd44f7b39;p=senf.git

fixed documentation for mcLoop


git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@694 270642c3-0616-0410-b53a-bc976706d245
---

diff --git a/Socket/Protocols/INet/MulticastSocketProtocol.hh b/Socket/Protocols/INet/MulticastSocketProtocol.hh
index b1dcf4a..1f24836 100644
--- a/Socket/Protocols/INet/MulticastSocketProtocol.hh
+++ b/Socket/Protocols/INet/MulticastSocketProtocol.hh
@@ -45,14 +45,14 @@ namespace senf {
         : public virtual SocketProtocol
     {
     public:
-        void broadcastEnabled(bool v) const; ///< Enable broadcast send/receive
+        void broadcastEnabled(bool v);  ///< Enable broadcast send/receive
                                         /**< If this option is enabled, broadcast UDP messages will
                                              be received on the socket and the socket will be
                                              allowed to send out broadcast UDP messages
                                              \param[in] v \c true to enable broadcast send/receive,
                                                  \c false to disable */
 
-        bool broadcastEnabled() const;  ///< Get broadcast send/receive state
+        bool broadcastEnabled();        ///< Get broadcast send/receive state
                                         /**< \returns Current state of the broadcastEnabled()
                                              option. */
 
@@ -60,8 +60,9 @@ namespace senf {
         unsigned mcTTL() const;         ///< Return current multicast TTL
         void mcTTL(unsigned value) const; ///< Set multicast TTL
 
-        bool mcLoop() const;            ///< Return current multicast loopback state
+        bool mcLoop() const;            ///< Return current multicast loopback state. 
         void mcLoop(bool value) const;  ///< Set multicast loopback state
+        /**< If set to false via \c mcLoop(value) multicast messages will not be looped back  to local sockets. Default value is \c true (1).   */
 
         void mcIface(std::string const & iface = std::string()) const;
                                         ///< Set multicast send interface of the socket