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

small documentation fixes

parent 5af52a39
No related branches found
No related tags found
No related merge requests found
...@@ -63,7 +63,7 @@ ...@@ -63,7 +63,7 @@
\image html ratestuffer.png \image html ratestuffer.png
Above image depicts the module setup implementing the rate stuffer. A Above image depicts the module setup implementing the rate stuffer. A
senf::ppi::module::ActiveSocketReader reads the incoming UDP packets and sends them into a senf::ppi::module::ActiveSocketSource reads the incoming UDP packets and sends them into a
senf::ppi::module::PassiveQueue (via a senf::ppi::module::ThrottleBarrier). senf::ppi::module::PassiveQueue (via a senf::ppi::module::ThrottleBarrier).
The \a queue feeds the packets into a senf::ppi::module::PriorityJoin. The CloneSource The \a queue feeds the packets into a senf::ppi::module::PriorityJoin. The CloneSource
......
...@@ -227,10 +227,10 @@ ...@@ -227,10 +227,10 @@
CopyPacketGenerator generator (stuffingPacket); CopyPacketGenerator generator (stuffingPacket);
senf::UDPv4ClientSocketHandle inputSocket (1111); senf::UDPv4ClientSocketHandle inputSocket (1111);
senf::ppi::module::ActiveSocketReader udpInput (inputSocket); senf::ppi::module::ActiveSocketSource<> udpInput (inputSocket);
senf::UDPv4ClientSocketHandle outputSocket ("2.3.4.5:2222"); senf::UDPv4ClientSocketHandle outputSocket ("2.3.4.5:2222");
senf::ppi::module::PassiveSocketWriter udpOutput (outputSocket); senf::ppi::module::PassiveSocketSink<> udpOutput (outputSocket);
senf::ppi::module::PassiveQueue adaptor; senf::ppi::module::PassiveQueue adaptor;
......
...@@ -45,15 +45,15 @@ namespace senf { ...@@ -45,15 +45,15 @@ namespace senf {
{ {
# include SENF_FIXED_PARSER() # include SENF_FIXED_PARSER()
SENF_PARSER_FIELD ( sync_byte , UInt8Parser ); SENF_PARSER_FIELD ( sync_byte, UInt8Parser );
SENF_PARSER_BITFIELD ( transport_error_indicator , 1 , bool ); SENF_PARSER_BITFIELD ( transport_error_indicator, 1, bool );
SENF_PARSER_BITFIELD ( pusi , 1 , bool ); SENF_PARSER_BITFIELD ( pusi, 1, bool );
SENF_PARSER_BITFIELD ( transport_priority , 1 , bool ); SENF_PARSER_BITFIELD ( transport_priority, 1, bool );
SENF_PARSER_BITFIELD ( pid , 13 , unsigned ); SENF_PARSER_BITFIELD ( pid, 13, unsigned );
SENF_PARSER_BITFIELD ( transport_scrmbl_ctrl , 2 , unsigned ); SENF_PARSER_BITFIELD ( transport_scrmbl_ctrl, 2, unsigned );
SENF_PARSER_BITFIELD ( adaptation_field_ctrl , 2 , unsigned ); SENF_PARSER_BITFIELD ( adaptation_field_ctrl, 2, unsigned );
SENF_PARSER_BITFIELD ( continuity_counter , 4 , unsigned ); SENF_PARSER_BITFIELD ( continuity_counter, 4, unsigned );
SENF_PARSER_FINALIZE( TransportPacketParser ); SENF_PARSER_FINALIZE( TransportPacketParser );
......
...@@ -119,8 +119,7 @@ namespace senf { ...@@ -119,8 +119,7 @@ namespace senf {
multicast groups received. The group is left from the multicast groups received. The group is left from the
interface with the given local address. interface with the given local address.
\param[in] mcAddr address of group to leave \param[in] mcAddr address of group to leave
\param[in] localAddr address of interface to leave \param[in] iface interface name */
from */
}; };
class INet6MulticastProtocol class INet6MulticastProtocol
......
...@@ -46,7 +46,7 @@ ...@@ -46,7 +46,7 @@
<em>Runtime</em> configuration on the other hand deals with routing all those messages, which <em>Runtime</em> configuration on the other hand deals with routing all those messages, which
are enabled at compile time to the logging targets. If a message is not routed, it will be are enabled at compile time to the logging targets. If a message is not routed, it will be
discarded. This allows to additionally disable messages at run-time. Message routing is managed discarded. This allows to additionally disable messages at run-time. Message routing is managed
via the \ref Target interface. via the \ref Targets interface.
\section config_compile Compile time configuration \section config_compile Compile time configuration
......
...@@ -110,7 +110,7 @@ namespace log { ...@@ -110,7 +110,7 @@ namespace log {
/** \brief Default global log stream */ /** \brief Default global log stream */
SENF_LOG_DEF_STREAM(Debug, MESSAGE, MESSAGE, MESSAGE); SENF_LOG_DEF_STREAM(Debug, MESSAGE, MESSAGE, MESSAGE);
/** \brief Default global log area */ /** \brief Default global %log area */
SENF_LOG_DEF_AREA(DefaultArea); SENF_LOG_DEF_AREA(DefaultArea);
///\} ///\}
......
...@@ -37,12 +37,12 @@ ...@@ -37,12 +37,12 @@
namespace senf { namespace senf {
namespace log { namespace log {
/** \brief Log target writing to a log file. /** \brief Log target writing to a %log file.
The FileTarget will save all log messages in the given file. Messages will be appended at The FileTarget will save all %log messages in the given file. Messages will be appended at
the end of the file. the end of the file.
After log files have been rotated, the reopen() member should be called to create a new log After %log files have been rotated, the reopen() member should be called to create a new %log
file. file.
\ingroup targets \ingroup targets
...@@ -63,8 +63,8 @@ namespace log { ...@@ -63,8 +63,8 @@ namespace log {
///@} ///@}
/////////////////////////////////////////////////////////////////////////// ///////////////////////////////////////////////////////////////////////////
void reopen(); ///< Reopen log after log-file rotation void reopen(); ///< Reopen %log after log-file rotation
void reopen(std::string file); ///< Reopen log under a new name void reopen(std::string file); ///< Reopen %log under a new name
private: private:
std::string file_; std::string file_;
......
...@@ -37,9 +37,9 @@ ...@@ -37,9 +37,9 @@
namespace senf { namespace senf {
namespace log { namespace log {
/** \brief Write log messages to arbitrary std::ostream /** \brief Write %log messages to arbitrary std::ostream
This target will write log messages to an arbitrary std::ostream in the format This target will write %log messages to an arbitrary std::ostream in the format
<pre> <pre>
<date> [<area>] <message> <date> [<area>] <message>
</pre> </pre>
......
...@@ -36,7 +36,7 @@ ...@@ -36,7 +36,7 @@
namespace senf { namespace senf {
namespace log { namespace log {
/** \brief Store log messages in a string buffer /** \brief Store %log messages in a string buffer
This target is mostly useful for debug purposes. This target is mostly useful for debug purposes.
......
...@@ -56,7 +56,7 @@ namespace log { ...@@ -56,7 +56,7 @@ namespace log {
/** \brief Logging target base class /** \brief Logging target base class
Targets are the final destination of log messages. Every message is eventually routed to one Targets are the final destination of %log messages. Every message is eventually routed to one
or several targets. or several targets.
\section target_routing Routing \section target_routing Routing
...@@ -383,7 +383,7 @@ namespace log { ...@@ -383,7 +383,7 @@ namespace log {
simple logging over NFS or many other network simple logging over NFS or many other network
protocols. protocols.
\param[in] timestamp log message timing information \param[in] timestamp %log message timing information
\param[in] stream message stream \param[in] stream message stream
\param[in] area message area \param[in] area message area
\param[in] level message level \param[in] level message level
...@@ -415,7 +415,7 @@ namespace log { ...@@ -415,7 +415,7 @@ namespace log {
virtual boost::posix_time::ptime operator()() const = 0; virtual boost::posix_time::ptime operator()() const = 0;
}; };
/** \brief Default log message time source /** \brief Default %log message time source
This time source is installed by default and uses gettimeofday() (via the Boost.DateTime This time source is installed by default and uses gettimeofday() (via the Boost.DateTime
library) to get the current universal time. library) to get the current universal time.
......
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