master/master.c
branchstable-1.5
changeset 2522 ec403cf308eb
parent 2498 9cdd7669dc0b
child 2529 c7e1f2616a9d
--- a/master/master.c	Tue Feb 12 15:30:34 2013 +0100
+++ b/master/master.c	Tue Feb 12 15:46:43 2013 +0100
@@ -614,6 +614,8 @@
 /*****************************************************************************/
 
 /** Transition function from ORPHANED to IDLE phase.
+ *
+ * \return Zero on success, otherwise a negative error code.
  */
 int ec_master_enter_idle_phase(
         ec_master_t *master /**< EtherCAT master */
@@ -669,6 +671,8 @@
 /*****************************************************************************/
 
 /** Transition function from IDLE to OPERATION phase.
+ *
+ * \return Zero on success, otherwise a negative error code.
  */
 int ec_master_enter_operation_phase(
         ec_master_t *master /**< EtherCAT master */
@@ -897,6 +901,8 @@
 /*****************************************************************************/
 
 /** Searches for a free datagram in the external datagram ring.
+ *
+ * \return Next free datagram, or NULL.
  */
 ec_datagram_t *ec_master_get_external_datagram(
         ec_master_t *master /**< EtherCAT master */
@@ -1779,6 +1785,8 @@
     } while (0)
 
 /** Finds a slave in the bus, given the alias and position.
+ *
+ * \return Search result, or NULL.
  */
 ec_slave_t *ec_master_find_slave(
         ec_master_t *master, /**< EtherCAT master. */
@@ -1793,6 +1801,8 @@
 /** Finds a slave in the bus, given the alias and position.
  *
  * Const version.
+ *
+ * \return Search result, or NULL.
  */
 const ec_slave_t *ec_master_find_slave_const(
         const ec_master_t *master, /**< EtherCAT master. */
@@ -2068,6 +2078,8 @@
 /*****************************************************************************/
 
 /** Calculates the bus topology; recursion function.
+ *
+ * \return Zero on success, otherwise a negative error code.
  */
 int ec_master_calc_topology_rec(
         ec_master_t *master, /**< EtherCAT master. */
@@ -2199,6 +2211,8 @@
  *****************************************************************************/
 
 /** Same as ecrt_master_create_domain(), but with ERR_PTR() return value.
+ *
+ * \return New domain, or ERR_PTR() return value.
  */
 ec_domain_t *ecrt_master_create_domain_err(
         ec_master_t *master /**< master */