Skip to content
Snippets Groups Projects
Commit cff23828 authored by tho's avatar tho
Browse files

use new doxygen command \tparam

parent 9a98b14d
No related branches found
No related tags found
No related merge requests found
...@@ -44,20 +44,22 @@ namespace senf { ...@@ -44,20 +44,22 @@ namespace senf {
/** \brief basic SocketHandle supporting protocol and policy abstraction /** \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 library. senf::SocketHandle does \e not provide socket functions it only provides the
infrastructure necessary to support both, the protocol and the policy interface. 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 introduces the protocol class. However, the class has no public constructors (see the
derived classes senf::ProtocolClientSocketHandle and senf::ProtocolServerSocketHandle). 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 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 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 only valid conversions are possible (see the implementation source for a more complete
discussion). discussion).
\tparam SPolicy socket policy
\note This class is \e not meant to be used as a base-class outside the library \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. implementation; The protected interface is for internal use only.
......
...@@ -205,9 +205,9 @@ namespace log { ...@@ -205,9 +205,9 @@ namespace log {
See the class description for information on the \a See the class description for information on the \a
action and \a index parameters action and \a index parameters
\param[in] Stream mandatory stream to match \tparam Stream mandatory stream to match
\param[in] Area optional area to match \tparam Area optional area to match
\param[in] Level optional level, matches messages with \tparam Level optional level, matches messages with
at least the given level. at least the given level.
\param[in] action routing action to take \param[in] action routing action to take
\param[in] index position of new route in the routing \param[in] index position of new route in the routing
...@@ -254,9 +254,9 @@ namespace log { ...@@ -254,9 +254,9 @@ namespace log {
found, it will be removed, otherwise the call will be found, it will be removed, otherwise the call will be
ignored ignored
\param[in] Stream mandatory stream to match \tparam Stream mandatory stream to match
\param[in] Area optional area to match \tparam Area optional area to match
\param[in] Level optional level, matches messages with \tparam Level optional level, matches messages with
at least the given level. at least the given level.
\param[in] action routing action to take */ \param[in] action routing action to take */
...@@ -373,9 +373,9 @@ namespace log { ...@@ -373,9 +373,9 @@ namespace log {
std::string const & message) = 0; std::string const & message) = 0;
///< Called to write out the routing message ///< Called to write out the routing message
/**< This member must be defined in the derived class to /**< 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). meta information (\a stream, \a area and \a level).
\note This member must \e not block since it may be \note This member must \e not block since it may be
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment