Added some documentation.
authorFlorian Pose <fp@igh-essen.com>
Wed, 10 Jan 2007 10:58:49 +0000
changeset 527 3eea08638522
parent 526 56522899acd1
child 528 f789bdd78b54
Added some documentation.
master/datagram.h
master/master.c
--- a/master/datagram.h	Wed Jan 10 10:51:43 2007 +0000
+++ b/master/datagram.h	Wed Jan 10 10:58:49 2007 +0000
@@ -89,12 +89,15 @@
 
 typedef union
 {
+    /**
+     * Physical address.
+     */
     struct
     {
         uint16_t slave; /**< configured or autoincrement address */
         uint16_t mem; /**< physical memory address */
     }
-    physical; /**< physical address */
+    physical;
 
     uint32_t logical; /**< logical address */
 }
--- a/master/master.c	Wed Jan 10 10:51:43 2007 +0000
+++ b/master/master.c	Wed Jan 10 10:58:49 2007 +0000
@@ -374,6 +374,7 @@
 /*****************************************************************************/
 
 /**
+ * Transition function from ORPHANED to IDLE mode.
 */
 
 int ec_master_enter_idle_mode(ec_master_t *master /**< EtherCAT master */)
@@ -394,6 +395,7 @@
 /*****************************************************************************/
 
 /**
+ * Transition function from IDLE to ORPHANED mode.
 */
 
 void ec_master_leave_idle_mode(ec_master_t *master /**< EtherCAT master */)
@@ -408,6 +410,7 @@
 /*****************************************************************************/
 
 /**
+ * Transition function from IDLE to OPERATION mode.
 */
 
 int ec_master_enter_operation_mode(ec_master_t *master /**< EtherCAT master */)
@@ -467,6 +470,7 @@
 /*****************************************************************************/
 
 /**
+ * Transition function from OPERATION to IDLE mode.
 */
 
 void ec_master_leave_operation_mode(ec_master_t *master