[Moss-devel] CVS: moss/colpatik/include/modules/filter Filter.h,1.4,1.5

[Alexander Feder <address@hidden>]

Update of /cvsroot/moss/moss/colpatik/include/modules/filter
In directory subversions:/tmp/cvs-serv19556/include/modules/filter

Modified Files:
        Filter.h 
Log Message:
added some doxygen stuff


Index: Filter.h
===================================================================
RCS file: /cvsroot/moss/moss/colpatik/include/modules/filter/Filter.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** Filter.h    30 Oct 2002 23:35:52 -0000      1.4
--- Filter.h    4 Dec 2002 15:48:14 -0000       1.5
***************
*** 35,38 ****
--- 35,43 ----
  #define __FILTER_H
  
+ /**
+  * @file
+  * Filter.
+  */
+ 
  #if _MSC_VER >= 1000
  #pragma once
***************
*** 54,57 ****
--- 59,65 ----
    typedef long (*fnFilterCallback)(CEvent& roEvent);
  
+ /** 
+  * The Filter Class. TODO a detailed description
+  */
    class CFilter
      {
***************
*** 60,70 ****
--- 68,95 ----
        
      public:
+                /**
+                 * Constructor.
+                 */
                 CFilter();
+                /**
+                 * Constructor.
+                 * @param rsFilter defines the name? or what? TODO.
+                 */
                 CFilter(const std::string& rsFilter);
+                /**
+                 * Destructor.
+                 */
        virtual ~CFilter();    
  
+       /**
+        * a stream operator TODO.
+        * @param roEvent a reference to an event.
+        */
        CEvent& operator << (CEvent& roEvent);
  
      protected:
+       /**
+        * Initialization.
+        */
        void Initialize();