master/fsm_coe.c
branchstable-1.5
changeset 2522 ec403cf308eb
parent 2498 9cdd7669dc0b
--- a/master/fsm_coe.c	Tue Feb 12 15:30:34 2013 +0100
+++ b/master/fsm_coe.c	Tue Feb 12 15:46:43 2013 +0100
@@ -27,7 +27,8 @@
  *
  *****************************************************************************/
 
-/** \file EtherCAT CoE state machines.
+/** \file
+ * EtherCAT CoE state machines.
  */
 
 /*****************************************************************************/
@@ -307,6 +308,10 @@
  *  CoE dictionary state machine
  *****************************************************************************/
 
+/** Prepare a dictionary request.
+ *
+ * \return Zero on success, otherwise a negative error code.
+ */
 int ec_fsm_coe_prepare_dict(
         ec_fsm_coe_t *fsm, /**< Finite state machine. */
         ec_datagram_t *datagram /**< Datagram to use. */
@@ -455,6 +460,10 @@
 
 /*****************************************************************************/
 
+/** Prepare an object description request.
+ *
+ * \return Zero on success, otherwise a negative error code.
+ */
 int ec_fsm_coe_dict_prepare_desc(
         ec_fsm_coe_t *fsm, /**< Finite state machine. */
         ec_datagram_t *datagram /**< Datagram to use. */
@@ -733,6 +742,10 @@
 
 /*****************************************************************************/
 
+/** Prepare an entry description request.
+ *
+ * \return Zero on success, otherwise a negative error code.
+ */
 int ec_fsm_coe_dict_prepare_entry(
         ec_fsm_coe_t *fsm, /**< Finite state machine */
         ec_datagram_t *datagram /**< Datagram to use. */
@@ -1172,6 +1185,10 @@
  *  CoE state machine
  *****************************************************************************/
 
+/** Prepare a donwnload request.
+ *
+ * \return Zero on success, otherwise a negative error code.
+ */
 int ec_fsm_coe_prepare_down_start(
         ec_fsm_coe_t *fsm, /**< Finite state machine. */
         ec_datagram_t *datagram /**< Datagram to use. */
@@ -1814,6 +1831,10 @@
 
 /*****************************************************************************/
 
+/** Prepare an upload request.
+ *
+ * \return Zero on success, otherwise a negative error code.
+ */
 int ec_fsm_coe_prepare_up(
         ec_fsm_coe_t *fsm, /**< Finite state machine. */
         ec_datagram_t *datagram /**< Datagram to use. */