Fix doxygen build warnings for SOEM 1.4.0 (#312)

Trvial non-code changes

doc/soem.dox

@@ -1,7 +1,7 @@
 /**
  * \mainpage Simple Open EtherCAT Master or SOEM
  *
- * \section start Tutorial
+ * \section tutorial Tutorial
  * For a tutorial on SOEM  See tutorial.txt
  *
  * \section overview Overview

doc/tutorial.txt

@@ -231,11 +231,11 @@ Below is an example on how to assign a slave to a group. <b>OBS!</b> A slave can
    {
       if ( <some condition> )
       {
-         ec_slave[cnt].group = <X>;
+         ec_slave[cnt].group = X;
       }
       else
       {
-         ec_slave[cnt].group = <Y>;
+         ec_slave[cnt].group = Y;
       }      
    }
 \endcode
@@ -247,23 +247,23 @@ This option will share IOmap and store the group IOmap data at offset EC_LOGGROU
    ec_config_map_group(&IOmap, 0);
 \endcode
 
-Alternative 2, configure the slave groups one by one, call ec_config_map or ec_config_map_group with arg <X>, <Y>. 
+Alternative 2, configure the slave groups one by one, call ec_config_map or ec_config_map_group with arg X, Y.
 This option will use different, supplied by the user, IOmaps.
 
 \code
-   ec_config_map_group(&IOmap1, <X>);
-   ec_config_map_group(&IOmap2, <Y>);
+   ec_config_map_group(&IOmap1, X);
+   ec_config_map_group(&IOmap2, Y);
 \endcode
 
 To exchange process data for given group(s) the user must call send/recv process data per group.
 The send and receive stack of process data don't consider groups, so the application has to send
 and receive the process data for one group before sending/receiving process data for another group.
 
 \code
-         ec_send_processdata_group(<X>);
-         ec_receive_processdata_group(<X>, EC_TIMEOUTRET);
-         ec_send_processdata_group(<Y>);
-         ec_receive_processdata_group(<Y>, EC_TIMEOUTRET);
+         ec_send_processdata_group(X);
+         ec_receive_processdata_group(X, EC_TIMEOUTRET);
+         ec_send_processdata_group(Y);
+         ec_receive_processdata_group(Y, EC_TIMEOUTRET);
 \endcode
 
 \section application Application

soem/ethercateoe.c

@@ -61,7 +61,7 @@ int ecx_EOEdefinehook(ecx_contextt *context, void *hook)
 * @param[in]  slave      = Slave number
 * @param[in]  port       = Port number on slave if applicable
 * @param[in]  ipparam    = IP parameter data to be sent
-* @param[in]  Timeout    = Timeout in us, standard is EC_TIMEOUTRXM
+* @param[in]  timeout    = Timeout in us, standard is EC_TIMEOUTRXM
 * @return Workcounter from last slave response or returned result code 
 */
 int ecx_EOEsetIp(ecx_contextt *context, uint16 slave, uint8 port, eoe_param_t * ipparam, int timeout)
@@ -175,7 +175,7 @@ int ecx_EOEsetIp(ecx_contextt *context, uint16 slave, uint8 port, eoe_param_t *
 * @param[in]  slave      = Slave number
 * @param[in]  port       = Port number on slave if applicable
 * @param[out] ipparam    = IP parameter data retrived from slave
-* @param[in]  Timeout    = Timeout in us, standard is EC_TIMEOUTRXM
+* @param[in]  timeout    = Timeout in us, standard is EC_TIMEOUTRXM
 * @return Workcounter from last slave response or returned result code
 */
 int ecx_EOEgetIp(ecx_contextt *context, uint16 slave, uint8 port, eoe_param_t * ipparam, int timeout)
@@ -316,7 +316,7 @@ int ecx_EOEgetIp(ecx_contextt *context, uint16 slave, uint8 port, eoe_param_t *
 * @param[in]  port       = Port number on slave if applicable
 * @param[in]  psize      = Size in bytes of parameter buffer.
 * @param[in]  p          = Pointer to parameter buffer
-* @param[in]  Timeout    = Timeout in us, standard is EC_TIMEOUTRXM
+* @param[in]  timeout    = Timeout in us, standard is EC_TIMEOUTRXM
 * @return Workcounter from last slave transmission
 */
 int ecx_EOEsend(ecx_contextt *context, uint16 slave, uint8 port, int psize, void *p, int timeout)
@@ -407,7 +407,7 @@ int ecx_EOEsend(ecx_contextt *context, uint16 slave, uint8 port, int psize, void
 * @param[in]     context = context struct
 * @param[in]     slave   = Slave number
 * @param[in]     port    = Port number on slave if applicable
-* @param[in/out] psize   = Size in bytes of parameter buffer.
+* @param[in,out] psize   = Size in bytes of parameter buffer.
 * @param[in]     p       = Pointer to parameter buffer
 * @param[in]     timeout = Timeout in us, standard is EC_TIMEOUTRXM
 * @return Workcounter from last slave response or error code
@@ -523,11 +523,11 @@ int ecx_EOErecv(ecx_contextt *context, uint16 slave, uint8 port, int * psize, vo
 * Ethernet frame buffer at given offset and update current fragment variables
 *
 * @param[in] MbxIn             = Received mailbox containing fragment data
-* @param[in/out] rxfragmentno  = Fragment number
-* @param[in/out] rxframesize   = Frame size
-* @param[in/out] rxframeoffset = Frame offset
-* @param[in/out] rxframeno     = Frame number
-* @param[in/out] psize         = Size in bytes of frame buffer.
+* @param[in,out] rxfragmentno  = Fragment number
+* @param[in,out] rxframesize   = Frame size
+* @param[in,out] rxframeoffset = Frame offset
+* @param[in,out] rxframeno     = Frame number
+* @param[in,out] psize         = Size in bytes of frame buffer.
 * @param[out] p                = Pointer to frame buffer
 * @return 0= if fragment OK, >0 if last fragment, <0 on error
 */

soem/ethercatmain.c

@@ -1691,6 +1691,7 @@ static void ecx_clearindex(ecx_contextt *context)  {
  * In order to recombine the slave response, a stack is used.
  * @param[in]  context        = context struct
  * @param[in]  group          = group number
+ * @param[in]  use_overlap_io = flag if overlapped iomap is used
  * @return >0 if processdata is transmitted.
  */
 static int ecx_main_send_processdata(ecx_contextt *context, uint8 group, boolean use_overlap_io)
@@ -2356,7 +2357,6 @@ int ec_send_processdata_group(uint8 group)
 * In contrast to the base LRW function this function is non-blocking.
 * If the processdata does not fit in one datagram, multiple are used.
 * In order to recombine the slave response, a stack is used.
-* @param[in]  context        = context struct
 * @param[in]  group          = group number
 * @return >0 if processdata is transmitted.
 * @see ecx_send_overlap_processdata_group