From: tho Date: Thu, 29 Mar 2007 11:54:15 +0000 (+0000) Subject: some small documentation fixes X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=49f2e00bdc4014b34361a0830e7ec365844ee67a;p=senf.git some small documentation fixes git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@224 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Examples/MCSniffer/MCSniffer.cc b/Examples/MCSniffer/MCSniffer.cc index 7eecb55..f353b2c 100644 --- a/Examples/MCSniffer/MCSniffer.cc +++ b/Examples/MCSniffer/MCSniffer.cc @@ -21,24 +21,17 @@ // Definition of non-inline non-template functions -//#include "Sniffer.hh" -//#include "Sniffer.ih" +//#include "MCSniffer.hh" +//#include "MCSniffer.ih" // Custom includes -#include #include -#include -#include -#include -#include -#include #include -#include #include #include "Socket/UDPSocketHandle.hh" #include "Scheduler/Scheduler.hh" -#include "Utils/membind.hh" #include "Packets/EthernetPacket.hh" +#include "Utils/membind.hh" //#include "MCSniffer.mpp" @@ -87,20 +80,20 @@ namespace { } -class MSniffer +class MCSniffer { senf::UDPv4ClientSocketHandle sock; std::ostream& stream; public: - MSniffer(senf::INet4Address addr, std::ostream& s) + MCSniffer(senf::INet4Address addr, std::ostream& s) : stream(s) { sock.protocol().bind(addr); sock.protocol().mcLoop(true); sock.protocol().mcAddMembership(addr); senf::Scheduler::instance().add( - sock, senf::membind(&MSniffer::dumpPacket, this)); + sock, senf::membind(&MCSniffer::dumpPacket, this)); } private: @@ -125,9 +118,9 @@ int main(int argc, char const * argv[]) std::ofstream f1 ("233.132.152.1.txt"); std::ofstream f2 ("233.132.152.2.txt"); - MSniffer sniffer1 ( + MCSniffer sniffer1 ( senf::INet4Address::INet4Address("233.132.152.1:22344"), f1); - MSniffer sniffer2 ( + MCSniffer sniffer2 ( senf::INet4Address::INet4Address("233.132.152.2:22344"), f2); senf::Scheduler::instance().process(); @@ -141,7 +134,7 @@ int main(int argc, char const * argv[]) ///////////////////////////////cc.e//////////////////////////////////////// #undef prefix_ -//#include "Sniffer.mpp" +//#include "MCSniffer.mpp" // Local Variables: diff --git a/Scheduler/ReadHelper.hh b/Scheduler/ReadHelper.hh index c4fbbc8..cf78c58 100644 --- a/Scheduler/ReadHelper.hh +++ b/Scheduler/ReadHelper.hh @@ -90,7 +90,7 @@ namespace senf { \param[in] handle file descriptor or handle providing the Handle interface defined above. \param[in] maxSize maximum number of bytes to read - \param[in] cb callback + \param[in] callback callback \returns Smart pointer to new ReadHelper instance */ template @@ -106,7 +106,7 @@ namespace senf { the Handle interface defined above. \param[in] maxSize maximum number of bytes to read \param[in] predicate predicate to check - \param[in] cb callback + \param[in] callback callback \returns smart pointer to new ReadHelper instance */ ///@} diff --git a/Scheduler/WriteHelper.hh b/Scheduler/WriteHelper.hh index 998ae79..ccc2d26 100644 --- a/Scheduler/WriteHelper.hh +++ b/Scheduler/WriteHelper.hh @@ -73,7 +73,7 @@ namespace senf { \param[in] handle file descriptor or handle providing the Handle interface defined above. \param[in] data data to send - \param[in] cb callback + \param[in] callback callback \returns smart pointer to new WriteHelper instance */ ///@} diff --git a/Socket/PacketSocketHandle.hh b/Socket/PacketSocketHandle.hh index ef3d737..1acde96 100644 --- a/Socket/PacketSocketHandle.hh +++ b/Socket/PacketSocketHandle.hh @@ -1,4 +1,4 @@ -// $Id$ +// $Id:PacketSocketHandle.hh 218 2007-03-20 14:39:32Z tho $ // // Copyright (C) 2006 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) @@ -118,12 +118,12 @@ namespace senf { interface. The modes available are
-
\e None
No special mode set. Only receive +
None
No special mode set. Only receive packets addressed to the interface or of joined multicast groups
-
\e AllMulticast
Additionally receive all +
AllMulticast
Additionally receive all multicast traffic
-
\e Promiscuous
Receive all packets on the +
Promiscuous
Receive all packets on the wire
diff --git a/Socket/ServerSocketHandle.hh b/Socket/ServerSocketHandle.hh index 3a55787..b096036 100644 --- a/Socket/ServerSocketHandle.hh +++ b/Socket/ServerSocketHandle.hh @@ -1,4 +1,4 @@ -// $Id$ +// $Id:ServerSocketHandle.hh 218 2007-03-20 14:39:32Z tho $ // // Copyright (C) 2006 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) @@ -86,7 +86,7 @@ namespace senf { /** Depending on the type of \c Address, this will be either Address or Address const &. See call_traits documentation in - the Boost.Utility library\endlink. + the Boost.Utility library. */ typedef typename boost::call_traits
::param_type AddressParam; /// Corresponding client socket handle with the same policy @@ -182,7 +182,7 @@ namespace senf { ///< Accept new connection /**< This variant will additionally return the remote address of the client - \param[out] client address + \param[out] addr address \returns handle of new client connection \see \ref accept() */ diff --git a/Socket/SocketPolicy.hh b/Socket/SocketPolicy.hh index 8784edd..5d48e6d 100644 --- a/Socket/SocketPolicy.hh +++ b/Socket/SocketPolicy.hh @@ -1,4 +1,4 @@ -// $Id$ +// $Id:SocketPolicy.hh 218 2007-03-20 14:39:32Z tho $ // // Copyright (C) 2006 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS) @@ -429,7 +429,7 @@ namespace senf { This template is an example of the \e Axis \c Is family of template metafunctions. It will check, whether \c Trait is a valid compatible Policy class of \c SocketPolicy. \c Trait must - be derived from AddressingPolicyBase (respectively \i Policy \c Base). + be derived from AddressingPolicyBase (respectively \c Policy \c Base). \see \ref policy_group */ diff --git a/Utils/DaemonTools.hh b/Utils/DaemonTools.hh index cb33556..6ea30e9 100644 --- a/Utils/DaemonTools.hh +++ b/Utils/DaemonTools.hh @@ -61,7 +61,7 @@ namespace senf { terminal and start a new process group. */ void redirect_stdio(std::string const & path = "/dev/null"); ///< Redirect STDIN, STDOUT and STDERR /**< All standard file-descriptors will be redirected to the - given path defaulting to /dev/null + given path defaulting to /dev/null \param[in] path path to redirect to */ /// @} diff --git a/Utils/Logger.hh b/Utils/Logger.hh index 492dc0a..a1b3468 100644 --- a/Utils/Logger.hh +++ b/Utils/Logger.hh @@ -41,7 +41,7 @@ \endcode The last sequence element always is the log message. Before that we have a number of log - parameters in arbitrary order. Since giving all the parameters in every log message is + parameters in arbitrary order. Since giving all the parameters in every log message is to verbose, there are two helpful constructs to reduce the verbosity. Using \ref SENF_LOG_DEFAULTS it is possible to define the default logging parameters to be used within a given scope. Using \ref SENF_LOG_DEF_ALIAS you can define an alias (which is a scoped symbol) as an arbitrary @@ -131,7 +131,7 @@ namespace senf { This macro will write it's last argument to the log stream. The last argument must be an expression which will be placed after a streaming \c operator<< (like - some-log-sttream \c << last-macro-arg). + some-log-sttream \c << last-macro-arg). \code BOOST_LOG((parameters...)("log message " << args << ...)); \endcode