From 935f593f8117c8f0c7295f95fa312b4c2a8c62ad Mon Sep 17 00:00:00 2001
From: tho <tho@wiback.org>
Date: Thu, 22 Jan 2009 15:23:00 +0000
Subject: [PATCH] minor documentation fixes
---
PPI/AnnotationRouter.hh | 4 ++--
PPI/Connectors.hh | 4 ++--
PPI/MonitorModule.hh | 15 ++++++++-------
3 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/PPI/AnnotationRouter.hh b/PPI/AnnotationRouter.hh
index 1051ae139..218f0a4a5 100644
--- a/PPI/AnnotationRouter.hh
+++ b/PPI/AnnotationRouter.hh
@@ -38,7 +38,7 @@ namespace senf {
namespace ppi {
namespace module {
- /** \brief Route packets to destination according to some annotation value
+ /** \brief %Route packets to destination according to some annotation value
This router takes packet on a single input and directs them to one of it outputs depending
on a \ref packet_usage_annotation "packet annotation". Each output connected
@@ -48,7 +48,7 @@ namespace module {
The \a AnnotationType template parameter defines the routing key. This annotation must
support the following operations:
- \li Comparison with '<' (\c LessThanCompatable concept)
+ \li Comparison with '<' (\c LessThanComparable concept)
\li Copy construction and copy assignment (\c Copyable und \c Assignable concepts)
(e.g. via compiler synthesized copy constructor and assignment operator)
\li Output streaming to an ostream via '\c <<' (for error description purposes) (\c
diff --git a/PPI/Connectors.hh b/PPI/Connectors.hh
index 2e51e9f92..4f18a785d 100644
--- a/PPI/Connectors.hh
+++ b/PPI/Connectors.hh
@@ -526,7 +526,7 @@ namespace connector {
{
public:
PacketType operator()(); ///< Read packet
- /**< \throws std::bad_cast, if the %connector receives a
+ /**< \throws std::bad_cast if the %connector receives a
Packet which is not of type \a PacketType.
\returns newly read packet reference. */
PacketType read(); ///< Alias for operator()
@@ -549,7 +549,7 @@ namespace connector {
{
public:
PacketType operator()(); ///< Read packet
- /**< \throws std::bad_cast, if the %connector receives a
+ /**< \throws std::bad_cast if the %connector receives a
Packet which is not of type \a PacketType.
\returns newly read packet reference. */
PacketType read(); ///< Alias for operator()
diff --git a/PPI/MonitorModule.hh b/PPI/MonitorModule.hh
index d9ca8ae3b..74e7600e0 100644
--- a/PPI/MonitorModule.hh
+++ b/PPI/MonitorModule.hh
@@ -37,16 +37,17 @@ namespace senf {
namespace ppi {
namespace module {
- /** \brief Base class providing simple monitor module support
+ /** \brief Base class providing simple monitor %module support
- A monitor module is a module which needs information about traversing packets but does not
- really act on the packets. Because of this, it is \e optional to connect the output: If the
- output is not connected, the packets will be silently dropped.
+ A monitor %module is a \ref senf::ppi::module::Module "module" which needs information
+ about traversing packets but does not really act on the packets. Because of this, it is
+ \e optional to connect the output: If the output is not connected, the packets will be
+ silently dropped.
This allows to add monitor modules either into an existing chain or add them using an
ActiveDuplicator.
- To write a monitor module, derive from senf::ppi::module::MonitorModule instead of
+ To write a monitor %module, derive from senf::ppi::module::MonitorModule instead of
senf::ppi::module and implement v_handlePacket():
\code
@@ -55,7 +56,7 @@ namespace module {
{
SENF_PPI_MODULE(CountPackets);
public:
- SomeMonitor() : counter_ (0u) {}
+ CountPackets() : counter_ (0u) {}
private:
virtual void v_handlePacket(Packet const & p)
@@ -66,7 +67,7 @@ namespace module {
\endcode
You may of course add events (or even further connectors besides \c input and \c output
- provided by MonitorModule) to the module.
+ provided by MonitorModule) to the %module.
\tparam PacketType type of packet expected on input and sent on output. This is also the
type of the v_handlePacket() argument.
--
GitLab