X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FActiveFeeder.hh;h=cc67b62455ecfdc3e5402ab2a7aa0ecc4b22e1d8;hb=81447258e6ecc9b5d9434fa5a7d382684179c7ab;hp=a5450505e0a2c1d5a52848b4bb90d8f0d91a3294;hpb=0327b3f303ea2a61d44a30bfaac022874dcf2a0d;p=senf.git

diff --git a/PPI/ActiveFeeder.hh b/PPI/ActiveFeeder.hh
index a545050..cc67b62 100644
--- a/PPI/ActiveFeeder.hh
+++ b/PPI/ActiveFeeder.hh
@@ -38,6 +38,17 @@ namespace senf {
 namespace ppi {
 namespace module {
 
+    /** \brief Adapter to connect passive connectors
+
+        ActiveFeeder is an adapter module which allows to connect to passive connectors. As long as
+        none of the connectors is throttled, the ActiveFeeder will forward packets from it's input
+        to it's output.
+
+        \note For this Module to work correctly, it is very important for the connectors to be
+            correctly throttled. Otherwise the system might well hang in an endless loop.
+
+        \ingroup adapter_modules
+     */
     class ActiveFeeder
         : public Module
     {