Revision 1:2d33daf35ed1, committed 2014-09-10

Comitter:

macht

Date:

Wed Sep 10 05:05:17 2014 +0000

Parent:

0:b7a168dd2734

Child:

2:4e7d58236762

Commit message:

add API documentation

Changed in this revision

--- a/DigitalFilter.h	Wed Sep 10 04:28:53 2014 +0000
+++ b/DigitalFilter.h	Wed Sep 10 05:05:17 2014 +0000
@@ -18,52 +18,53 @@
 class DigitalFilter
 {
     public:
-        /**
-        * Create a DigitalFilter instance
+        
+        /** Create a DigitalFilter instance
         *@param filter_type desired filter type
         *@param fs sampling frequency
         */
         DigitalFilter(FilterType filter_type,float fs);    //constructor, choose filter type and set sampling frequency
-        /**
-        /**
-        * initialize DigitalFilter.Need to set several parameters before calling this method.
+        
+        /** initialize DigitalFilter.Need to set several parameters before calling this method.
         */
         int init();                  //calcurate and set filter coefficients.Return value is the delay step of designed filter.
-        /**
-        *Update filter outputs.
+        
+        /**Update filter outputs.
         *@param input latest input of filter
         */
         float update(float input);   //update filter outputs. 
-        /**
-        /*Reset buffer of filter
+        
+        /** Reset buffer of filter
         */
         void reset();                //reset filter inputs and past inputs(all past inputs set to 0)
-        /**
-        *accesor of fc(center frequency)
+        
+        
+        /**accesor of fc(center frequency)
         *@param fc center frequency
         */
         void set_fc(float fc);       //accesor of fc(center frequency)
-        /**
-        *accesor of zeta(decrement)
+        
+        /**accesor of zeta(decrement)
         *@param zeta decrement of filter
         */
         void set_zeta(float zeta);   //accesor of zeta(decrement)
-        /**
-        *accesor of q(quality factor)
+        
+        
+        /**accesor of q(quality factor)
         *@param q quality factor
         */
         void set_Q(float q);       //accesor of quality factor
-        /**
-        *accesor of tap(hilbert filter's tap number)
+        
+        /**accesor of tap(hilbert filter's tap number)
         *@param tap hilbert filter's tap number
         */
         void set_tap(int tap);     //accesor of hilbert filter's tap number
-        /**
-        *accesor of filter time constant
+        
+        /**accesor of filter time constant
         */
         float get_tau();          //accesor of filter time constant
-        /**
-        *accesor of delay_step
+        
+        /**accesor of delay_step
         */
         int get_delay_step();        //get delay step of designed filter