Diff: Line.cpp

Revision:

2:e37117117e79

Parent:

1:0f82c574096f

Child:

4:41a3534d085f

--- a/Line.cpp	Sun Dec 26 15:49:07 2010 +0000
+++ b/Line.cpp	Wed Jan 05 15:43:53 2011 +0000
@@ -1,3 +1,7 @@
+/** @file Line.cpp
+ * @brief Line Controller (mbed Phone Platform)
+ */
+
 #include "Line.h"
 
 #define RING_ON FREQ
@@ -27,8 +31,10 @@
     hook_last = hook;
 }
 
-/// 8KHz interrupt
-void Line::poll () {
+/**
+ * @brief 8KHz interrupt
+ */
+void Line::intr () {
 
     switch (mode) {
     case ModeRing:
@@ -77,7 +83,11 @@
     }
 }
 
-/// change mode
+/**
+ * @brief change mode
+ * @param newmode mode of line
+ * @retval 0 ok
+ */
 int Line::enter (enum Mode newmode) {
 
     // cleanup
@@ -127,7 +137,11 @@
     return 0;
 }
 
-/// return status
+/**
+ * @brief return status
+ * @param type Type of status
+ * @return status
+ */
 int Line::scan (enum Scan type) {
 
     switch (type) {
@@ -152,7 +166,10 @@
     return -1;
 }
 
-/// controll power
+/**
+ * @brief power of line
+ * @param flg 0:off, 1:on(positive), -1:on(negative)
+ */
 void Line::power (int flg) {
     if (flg > 0) {
         xline = 0;