X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FConnectors.hh;h=2750224e2e5d929ea8bf85505a8d633ed5ea2f7a;hb=23ef68f7c443f0993b2b46cd912666c040fdccba;hp=67d8c1bcb040d49234c7ca5edea014af737ee2b6;hpb=1b557e88c001f36b009047e8b7ccf06d471f16f8;p=senf.git diff --git a/PPI/Connectors.hh b/PPI/Connectors.hh index 67d8c1b..2750224 100644 --- a/PPI/Connectors.hh +++ b/PPI/Connectors.hh @@ -502,9 +502,10 @@ namespace connector { \tparam PacketType Type of packet to read. Defaults to senf::Packet - The ActiveInput connector template reads data actively from a connected module. This class - is completely implemented via it's base-class, GenericActiveInput, the only difference is - that read packets are returned as \a PacketType instead of generic senf::Packet references. + The %ActiveInput %connector template reads data actively from a connected %module. This + class is completely implemented via it's base-class, GenericActiveInput, the only + difference is that read packets are returned as \a PacketType instead of generic + senf::Packet references. \see GenericActiveInput \n senf::ppi::connector @@ -514,7 +515,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() @@ -524,9 +525,9 @@ namespace connector { \tparam PacketType Type of packet to read. Defaults to senf::Packet - The PassiveInput connector template receives packets sent to it from a connected - module. This class is completely implemented via it's base-class, GenericPassiveInput, the - only difference is that read packets are returned as \a PacketType instead of generic + The %PassiveInput %connector template receives packets sent to it from a connected + %module. This class is completely implemented via it's base-class, GenericPassiveInput, + the only difference is that read packets are returned as \a PacketType instead of generic senf::Packet references. \see GenericPassiveInput \n @@ -537,7 +538,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() @@ -547,9 +548,9 @@ namespace connector { \tparam PacketType Type of packet to send. Defaults to senf::Packet - The ActiveOutput connector template sends data actively to a connected module. This class is - completely implemented via it's base-class, GenericActiveOutput, the only difference is that - it only sends packets of type \a PacketType. + The %ActiveOutput %connector template sends data actively to a connected %module. This + class is completely implemented via it's base-class, GenericActiveOutput, the only + difference is that it only sends packets of type \a PacketType. \see GenericActiveOutput \n senf::ppi::connector @@ -566,9 +567,10 @@ namespace connector { \tparam PacketType Type of packet to send. Defaults to senf::Packet - The PassiveOutput connector template provides data passively to a connected module whenever - signaled. This class is completely implemented via it's base-class, GenericPassiveOutput, the - only difference is that it only sends packets of type \a PacketType. + The %PassiveOutput %connector template provides data passively to a connected %module + whenever signaled. This class is completely implemented via it's base-class, + GenericPassiveOutput, the only difference is that it only sends packets of type + \a PacketType. \see GenericPassiveOutput \n senf::ppi::connector