master/slave.c
branchstable-1.5
changeset 2522 ec403cf308eb
parent 2498 9cdd7669dc0b
--- a/master/slave.c	Tue Feb 12 15:30:34 2013 +0100
+++ b/master/slave.c	Tue Feb 12 15:46:43 2013 +0100
@@ -797,6 +797,8 @@
 /*****************************************************************************/
 
 /** Returns the previous connected port of a given port.
+ *
+ * \return Port index.
  */
 unsigned int ec_slave_get_previous_port(
         ec_slave_t *slave, /**< EtherCAT slave. */
@@ -825,6 +827,8 @@
 /*****************************************************************************/
 
 /** Returns the next connected port of a given port.
+ *
+ * \return Port index.
  */
 unsigned int ec_slave_get_next_port(
         ec_slave_t *slave, /**< EtherCAT slave. */
@@ -853,6 +857,8 @@
 /*****************************************************************************/
 
 /** Calculates the sum of round-trip-times of connected ports 1-3.
+ *
+ * \return Round-trip-time in ns.
  */
 uint32_t ec_slave_calc_rtt_sum(
         ec_slave_t *slave /**< EtherCAT slave. */
@@ -877,6 +883,8 @@
 /*****************************************************************************/
 
 /** Finds the next slave supporting DC delay measurement.
+ *
+ * \return Next DC slave, or NULL.
  */
 ec_slave_t *ec_slave_find_next_dc_slave(
         ec_slave_t *slave /**< EtherCAT slave. */