From e4145dc3be26de8cd8356f93c3a50fdfa3221804 Mon Sep 17 00:00:00 2001
From: tho <tho@wiback.org>
Date: Fri, 1 Feb 2008 14:17:48 +0000
Subject: [PATCH] small documentation fixes
---
Examples/RateStuffer/Mainpage.dox | 2 +-
PPI/Mainpage.dox | 4 ++--
Packets/MPEGDVBBundle/TransportPacket.hh | 18 +++++++++---------
Socket/Protocols/INet/MulticastProtocol.hh | 3 +--
Utils/Logger/Config.hh | 2 +-
Utils/Logger/Definitions.hh | 2 +-
Utils/Logger/FileTarget.hh | 10 +++++-----
Utils/Logger/IOStreamTarget.hh | 4 ++--
Utils/Logger/StringTarget.hh | 2 +-
Utils/Logger/Target.hh | 6 +++---
10 files changed, 26 insertions(+), 27 deletions(-)
diff --git a/Examples/RateStuffer/Mainpage.dox b/Examples/RateStuffer/Mainpage.dox
index c17c9b4c8..9f02568bb 100644
--- a/Examples/RateStuffer/Mainpage.dox
+++ b/Examples/RateStuffer/Mainpage.dox
@@ -63,7 +63,7 @@
\image html ratestuffer.png
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).
The \a queue feeds the packets into a senf::ppi::module::PriorityJoin. The CloneSource
diff --git a/PPI/Mainpage.dox b/PPI/Mainpage.dox
index 72b5f4b8c..2491f501a 100644
--- a/PPI/Mainpage.dox
+++ b/PPI/Mainpage.dox
@@ -227,10 +227,10 @@
CopyPacketGenerator generator (stuffingPacket);
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::ppi::module::PassiveSocketWriter udpOutput (outputSocket);
+ senf::ppi::module::PassiveSocketSink<> udpOutput (outputSocket);
senf::ppi::module::PassiveQueue adaptor;
diff --git a/Packets/MPEGDVBBundle/TransportPacket.hh b/Packets/MPEGDVBBundle/TransportPacket.hh
index ead0347dd..6e9caa2ee 100644
--- a/Packets/MPEGDVBBundle/TransportPacket.hh
+++ b/Packets/MPEGDVBBundle/TransportPacket.hh
@@ -45,15 +45,15 @@ namespace senf {
{
# include SENF_FIXED_PARSER()
- SENF_PARSER_FIELD ( sync_byte , UInt8Parser );
-
- SENF_PARSER_BITFIELD ( transport_error_indicator , 1 , bool );
- SENF_PARSER_BITFIELD ( pusi , 1 , bool );
- SENF_PARSER_BITFIELD ( transport_priority , 1 , bool );
- SENF_PARSER_BITFIELD ( pid , 13 , unsigned );
- SENF_PARSER_BITFIELD ( transport_scrmbl_ctrl , 2 , unsigned );
- SENF_PARSER_BITFIELD ( adaptation_field_ctrl , 2 , unsigned );
- SENF_PARSER_BITFIELD ( continuity_counter , 4 , unsigned );
+ SENF_PARSER_FIELD ( sync_byte, UInt8Parser );
+
+ SENF_PARSER_BITFIELD ( transport_error_indicator, 1, bool );
+ SENF_PARSER_BITFIELD ( pusi, 1, bool );
+ SENF_PARSER_BITFIELD ( transport_priority, 1, bool );
+ SENF_PARSER_BITFIELD ( pid, 13, unsigned );
+ SENF_PARSER_BITFIELD ( transport_scrmbl_ctrl, 2, unsigned );
+ SENF_PARSER_BITFIELD ( adaptation_field_ctrl, 2, unsigned );
+ SENF_PARSER_BITFIELD ( continuity_counter, 4, unsigned );
SENF_PARSER_FINALIZE( TransportPacketParser );
diff --git a/Socket/Protocols/INet/MulticastProtocol.hh b/Socket/Protocols/INet/MulticastProtocol.hh
index 1d3d0f66a..3ce6347ea 100644
--- a/Socket/Protocols/INet/MulticastProtocol.hh
+++ b/Socket/Protocols/INet/MulticastProtocol.hh
@@ -119,8 +119,7 @@ namespace senf {
multicast groups received. The group is left from the
interface with the given local address.
\param[in] mcAddr address of group to leave
- \param[in] localAddr address of interface to leave
- from */
+ \param[in] iface interface name */
};
class INet6MulticastProtocol
diff --git a/Utils/Logger/Config.hh b/Utils/Logger/Config.hh
index 938744483..6c1ae63b6 100644
--- a/Utils/Logger/Config.hh
+++ b/Utils/Logger/Config.hh
@@ -46,7 +46,7 @@
<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
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
diff --git a/Utils/Logger/Definitions.hh b/Utils/Logger/Definitions.hh
index 0c0fb3359..24c32f7d8 100644
--- a/Utils/Logger/Definitions.hh
+++ b/Utils/Logger/Definitions.hh
@@ -110,7 +110,7 @@ namespace log {
/** \brief Default global log stream */
SENF_LOG_DEF_STREAM(Debug, MESSAGE, MESSAGE, MESSAGE);
- /** \brief Default global log area */
+ /** \brief Default global %log area */
SENF_LOG_DEF_AREA(DefaultArea);
///\}
diff --git a/Utils/Logger/FileTarget.hh b/Utils/Logger/FileTarget.hh
index 9bc933194..45f1bd0ec 100644
--- a/Utils/Logger/FileTarget.hh
+++ b/Utils/Logger/FileTarget.hh
@@ -37,12 +37,12 @@
namespace senf {
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.
- 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.
\ingroup targets
@@ -63,8 +63,8 @@ namespace log {
///@}
///////////////////////////////////////////////////////////////////////////
- void reopen(); ///< Reopen log after log-file rotation
- void reopen(std::string file); ///< Reopen log under a new name
+ void reopen(); ///< Reopen %log after log-file rotation
+ void reopen(std::string file); ///< Reopen %log under a new name
private:
std::string file_;
diff --git a/Utils/Logger/IOStreamTarget.hh b/Utils/Logger/IOStreamTarget.hh
index d091a375a..94e1258ff 100644
--- a/Utils/Logger/IOStreamTarget.hh
+++ b/Utils/Logger/IOStreamTarget.hh
@@ -37,9 +37,9 @@
namespace senf {
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>
<date> [<area>] <message>
</pre>
diff --git a/Utils/Logger/StringTarget.hh b/Utils/Logger/StringTarget.hh
index cf8180807..c9591de5f 100644
--- a/Utils/Logger/StringTarget.hh
+++ b/Utils/Logger/StringTarget.hh
@@ -36,7 +36,7 @@
namespace senf {
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.
diff --git a/Utils/Logger/Target.hh b/Utils/Logger/Target.hh
index 74110c936..d8ed8d18b 100644
--- a/Utils/Logger/Target.hh
+++ b/Utils/Logger/Target.hh
@@ -56,7 +56,7 @@ namespace log {
/** \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.
\section target_routing Routing
@@ -383,7 +383,7 @@ namespace log {
simple logging over NFS or many other network
protocols.
- \param[in] timestamp log message timing information
+ \param[in] timestamp %log message timing information
\param[in] stream message stream
\param[in] area message area
\param[in] level message level
@@ -415,7 +415,7 @@ namespace log {
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
library) to get the current universal time.
--
GitLab