X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=PPI%2FJack.hh;h=52c6b82fcf93250ecbd282ca5f146d0aae419523;hb=c45c112ae88196ea8da9c5a9efb0e167196744d2;hp=83657ba7a804f4d8c8466c9ff1b70f147cf80a16;hpb=42a8e0da20196d7e74d701c1fb448a9946014686;p=senf.git

diff --git a/PPI/Jack.hh b/PPI/Jack.hh
index 83657ba..52c6b82 100644
--- a/PPI/Jack.hh
+++ b/PPI/Jack.hh
@@ -38,58 +38,70 @@ namespace senf {
 namespace ppi {
 namespace connector {
 
+    /** \brief Connector Jack base class
+        \see \ref ppi_jacks */
     class Jack
         : private boost::noncopyable
     {};
 
+    /** \brief Jack referencing an ActiveInput 
+        \see \ref ppi_jacks */
     class GenericActiveInputJack
         : public Jack
     {
     public:
         explicit GenericActiveInputJack(GenericActiveInput & input);
 
-        GenericActiveInput & connector();
+        GenericActiveInput & connector(); ///< Get referenced connector
 
     private:
         GenericActiveInput & input_;
     };
 
+    /** \brief Jack referencing an ActiveOutput
+        \see \ref ppi_jacks */
     class GenericActiveOutputJack
         : public Jack
     {
     public:
         explicit GenericActiveOutputJack(GenericActiveOutput & output);
 
-        GenericActiveOutput & connector();
+        GenericActiveOutput & connector(); ///< Get referenced connector
 
     private:
         GenericActiveOutput & output_;
     };
 
+    /** \brief Jack referencing a PassiveInput
+        \see \ref ppi_jacks */
     class GenericPassiveInputJack
         : public Jack
     {
     public:
         explicit GenericPassiveInputJack(GenericPassiveInput & input);
 
-        GenericPassiveInput & connector();
+        GenericPassiveInput & connector(); ///< Get referenced connector
 
     private:
         GenericPassiveInput & input_;
     };
     
+    /** \brief Jack referencing a PassiveOutput
+        \see \ref ppi_jacks */
     class GenericPassiveOutputJack
         : public Jack
     {
     public:
         explicit GenericPassiveOutputJack(GenericPassiveOutput & output);
 
-        GenericPassiveOutput & connector();
+        GenericPassiveOutput & connector(); ///< Get referenced connector
 
     private:
         GenericPassiveOutput & output_;
     };
 
+    /** \brief Jack with packet type referencing an ActiveInput
+        \see \ref ppi_jacks */
     template <class PacketType=Packet>
     class ActiveInputJack
         : public GenericActiveInputJack
@@ -109,12 +121,14 @@ namespace connector {
         : public GenericActiveInputJack
     {
     public:
-        explicit ActiveInputJack(ActiveInput<> & input);
-        explicit ActiveInputJack(ActiveInputJack & input);
+        explicit ActiveInputJack(GenericActiveInput & input);
+        explicit ActiveInputJack(GenericActiveInputJack input);
     };
 
 #endif
 
+    /** \brief Jack with packet type referencing an ActiveOutput
+        \see \ref ppi_jacks */
     template <class PacketType=Packet>
     class ActiveOutputJack
         : public GenericActiveOutputJack
@@ -134,12 +148,14 @@ namespace connector {
         : public GenericActiveOutputJack
     {
     public:
-        explicit ActiveOutputJack(ActiveOutput<> & output);
-        explicit ActiveOutputJack(ActiveOutputJack & output);
+        explicit ActiveOutputJack(GenericActiveOutput & output);
+        explicit ActiveOutputJack(GenericActiveOutputJack & output);
     };
 
 #endif
 
+    /** \brief Jack with packet type referencing a PassiveInput
+        \see \ref ppi_jacks */
     template <class PacketType=Packet>
     class PassiveInputJack
         : public GenericPassiveInputJack
@@ -159,12 +175,14 @@ namespace connector {
         : public GenericPassiveInputJack
     {
     public:
-        explicit PassiveInputJack(PassiveInput<> & input);
-        explicit PassiveInputJack(PassiveInputJack & input);
+        explicit PassiveInputJack(GenericPassiveInput & input);
+        explicit PassiveInputJack(GenericPassiveInputJack & input);
     };
 
 #endif
 
+    /** \brief Jack with packet type referencing a PassiveOutput
+        \see \ref ppi_jacks */
     template <class PacketType=Packet>
     class PassiveOutputJack
         : public GenericPassiveOutputJack
@@ -184,8 +202,8 @@ namespace connector {
         : public GenericPassiveOutputJack
     {
     public:
-        explicit PassiveOutputJack(PassiveOutput<> & output);
-        explicit PassiveOutputJack(PassiveOutputJack & output);
+        explicit PassiveOutputJack(GenericPassiveOutput & output);
+        explicit PassiveOutputJack(GenericPassiveOutputJack & output);
     };
 
 #endif