fixed typo in DVBSocket

added some doc in DVBSocket

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1149 270642c3-0616-0410-b53a-bc976706d245

diff --git a/Socket/Protocols/DVB/DVBDemuxHandles.hh b/Socket/Protocols/DVB/DVBDemuxHandles.hh
index 186f240..9b4b73a 100644 (file)
--- a/Socket/Protocols/DVB/DVBDemuxHandles.hh
+++ b/Socket/Protocols/DVB/DVBDemuxHandles.hh
@@ -52,22 +52,25 @@ namespace senf {
         NotWriteablePolicy
         >::policy DVBDemux_Policy;   ///< Socket Policy for xxxx
 
-    /** \brief xxx
+    /** \brief Baseclass of various DVBProtocolWrappers which are defined in DVBProtocolWrapper.hh 
      */
-    class DVBPrococolWrapper :public boost::enable_shared_from_this<DVBPrococolWrapper> {
+    class DVBProtocolWrapper :public boost::enable_shared_from_this<DVBProtocolWrapper> {
         public:
-            DVBPrococolWrapper(){}
-            virtual ~DVBPrococolWrapper(){}
+            DVBProtocolWrapper(){}
+            virtual ~DVBProtocolWrapper(){}
     };
-    
+    /** \brief Baseclass for DVBSocketProtocols which want use Wrappers for console. 
+    */
     class DVBSocketProtocol : public virtual SocketProtocol {
 private:
-        boost::shared_ptr<DVBPrococolWrapper> wrap_;
+        boost::shared_ptr<DVBProtocolWrapper> wrap_;
 public:
         DVBSocketProtocol() {}
         ~DVBSocketProtocol() {}
-
-        void addWrapper(boost::shared_ptr<DVBPrococolWrapper> wrap) {
+        
+        void addWrapper(boost::shared_ptr<DVBProtocolWrapper> wrap)/**< Binds a wrapper to a DVBProtocol, 
+                                                                        so if it is closed the functionality of the wrapper is automatically removed from console.*/ 
+        {
             wrap_ = wrap;
         }
         virtual void close(){

diff --git a/Socket/Protocols/DVB/DVBProtocolWrapper.hh b/Socket/Protocols/DVB/DVBProtocolWrapper.hh
index 9ae5ddd..cc694c6 100644 (file)
--- a/Socket/Protocols/DVB/DVBProtocolWrapper.hh
+++ b/Socket/Protocols/DVB/DVBProtocolWrapper.hh
@@ -46,7 +46,7 @@ namespace senf {
 
      */
 
-    class DVBSectionProtocolWrapper : public senf::DVBPrococolWrapper {
+    class DVBSectionProtocolWrapper : public senf::DVBProtocolWrapper {
 
 public:
         enum Flags {CHECK_CRC = DMX_CHECK_CRC,
@@ -116,7 +116,7 @@ public:
             (CHECK_CRC)(ONESHOT)(IMMEDIATE_START)(KERNEL_CLIENT))
     ;
 
-    class DVBPESProtocolWrapper : public senf::DVBPrococolWrapper {
+    class DVBPESProtocolWrapper : public senf::DVBProtocolWrapper {
 
 public:
         enum Flags {CHECK_CRC = DMX_CHECK_CRC,