From: tho Date: Mon, 11 Feb 2008 12:22:29 +0000 (+0000) Subject: use new doxygen command \tparam X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=445c71d8d242f4ce3d23d8db8d1faf909943cfec;p=senf.git use new doxygen command \tparam git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@683 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Socket/SocketHandle.hh b/Socket/SocketHandle.hh index 68cce02..d1b4250 100644 --- a/Socket/SocketHandle.hh +++ b/Socket/SocketHandle.hh @@ -44,20 +44,22 @@ namespace senf { /** \brief basic SocketHandle supporting protocol and policy abstraction - The senf::SocketHandle class introduces the two abstraction layers of the socket + The %senf::SocketHandle class introduces the two abstraction layers of the socket library. senf::SocketHandle does \e not provide socket functions it only provides the infrastructure necessary to support both, the protocol and the policy interface. - senf::SocketHandle takes the socket policy as a template argument. senf::SocketHandle also + %SocketHandle takes the socket policy as a template argument. %SocketHandle also introduces the protocol class. However, the class has no public constructors (see the derived classes senf::ProtocolClientSocketHandle and senf::ProtocolServerSocketHandle). - The most important functionality provided by senf::SocketHandle is the conversion + The most important functionality provided by %SocketHandle is the conversion constructor. This allows to implicitly convert between compatible socket handle types as specified by the socket policy. The conversion constructor is defined in such a way, that only valid conversions are possible (see the implementation source for a more complete discussion). + \tparam SPolicy socket policy + \note This class is \e not meant to be used as a base-class outside the library implementation; The protected interface is for internal use only. diff --git a/Utils/Logger/Target.hh b/Utils/Logger/Target.hh index 36d697c..0fec6a5 100644 --- a/Utils/Logger/Target.hh +++ b/Utils/Logger/Target.hh @@ -205,9 +205,9 @@ namespace log { See the class description for information on the \a action and \a index parameters - \param[in] Stream mandatory stream to match - \param[in] Area optional area to match - \param[in] Level optional level, matches messages with + \tparam Stream mandatory stream to match + \tparam Area optional area to match + \tparam Level optional level, matches messages with at least the given level. \param[in] action routing action to take \param[in] index position of new route in the routing @@ -254,9 +254,9 @@ namespace log { found, it will be removed, otherwise the call will be ignored - \param[in] Stream mandatory stream to match - \param[in] Area optional area to match - \param[in] Level optional level, matches messages with + \tparam Stream mandatory stream to match + \tparam Area optional area to match + \tparam Level optional level, matches messages with at least the given level. \param[in] action routing action to take */ @@ -373,9 +373,9 @@ namespace log { std::string const & message) = 0; ///< Called to write out the routing message /**< This member must be defined in the derived class to - somehow format and write the log message. + somehow format and write the %log message. - Every log message always possesses a complete set of + Every %log message always possesses a complete set of meta information (\a stream, \a area and \a level). \note This member must \e not block since it may be