--- a/master/canopen.c Fri Apr 21 13:05:01 2006 +0000
+++ b/master/canopen.c Mon Apr 24 10:10:02 2006 +0000
@@ -1,9 +1,5 @@
/******************************************************************************
*
- * c a n o p e n . c
- *
- * CANopen over EtherCAT
- *
* $Id$
*
* Copyright (C) 2006 Florian Pose, Ingenieurgemeinschaft IgH
@@ -25,6 +21,13 @@
*
*****************************************************************************/
+/**
+ \file
+ Canopen-over-EtherCAT functions.
+*/
+
+/*****************************************************************************/
+
#include <linux/delay.h>
#include <linux/slab.h>
#include <linux/module.h>
@@ -47,7 +50,6 @@
/**
Reads 32 bit of a CANopen SDO in expedited mode.
\return 0 in case of success, else < 0
- \ingroup Slave
*/
int ec_slave_sdo_read_exp(ec_slave_t *slave, /**< EtherCAT slave */
@@ -97,7 +99,6 @@
/**
Writes a CANopen SDO using expedited mode.
\return 0 in case of success, else < 0
- \ingroup Slave
*/
int ec_slave_sdo_write_exp(ec_slave_t *slave, /**< EtherCAT slave */
@@ -157,8 +158,8 @@
/**
Reads a CANopen SDO in normal mode.
\return 0 in case of success, else < 0
- \ingroup Slave
- \todo size
+ \ingroup RealtimeInterface
+ \todo Make size non-pointer.
*/
int ecrt_slave_sdo_read(ec_slave_t *slave, /**< EtherCAT slave */
@@ -228,7 +229,6 @@
/**
Fetches the SDO dictionary of a slave.
\return 0 in case of success, else < 0
- \ingroup Slave
*/
int ec_slave_fetch_sdo_list(ec_slave_t *slave /**< EtherCAT slave */)
@@ -311,7 +311,6 @@
/**
Fetches the SDO descriptions for the known SDOs.
\return 0 in case of success, else < 0
- \ingroup Slave
*/
int ec_slave_fetch_sdo_descriptions(ec_slave_t *slave /**< EtherCAT slave */)
@@ -390,7 +389,6 @@
/**
Fetches all entries (subindices) to an SDO.
\return 0 in case of success, else < 0
- \ingroup Slave
*/
int ec_slave_fetch_sdo_entries(ec_slave_t *slave, /**< EtherCAT slave */
@@ -538,7 +536,7 @@
Reads an 8-bit SDO in expedited mode.
See ec_slave_sdo_read_exp()
\return 0 in case of success, else < 0
- \ingroup Slave
+ \ingroup RealtimeInterface
*/
int ecrt_slave_sdo_read_exp8(ec_slave_t *slave, /**< EtherCAT slave */
@@ -559,7 +557,7 @@
Reads a 16-bit SDO in expedited mode.
See ec_slave_sdo_read_exp()
\return 0 in case of success, else < 0
- \ingroup Slave
+ \ingroup RealtimeInterface
*/
int ecrt_slave_sdo_read_exp16(ec_slave_t *slave, /**< EtherCAT slave */
@@ -580,7 +578,7 @@
Reads a 32-bit SDO in expedited mode.
See ec_slave_sdo_read_exp()
\return 0 in case of success, else < 0
- \ingroup Slave
+ \ingroup RealtimeInterface
*/
int ecrt_slave_sdo_read_exp32(ec_slave_t *slave, /**< EtherCAT slave */
@@ -600,7 +598,7 @@
/**
Writes an 8-bit SDO in expedited mode.
\return 0 in case of success, else < 0
- \ingroup Slave
+ \ingroup RealtimeInterface
*/
int ecrt_slave_sdo_write_exp8(ec_slave_t *slave, /**< EtherCAT slave */
@@ -617,7 +615,7 @@
/**
Writes a 16-bit SDO in expedited mode.
\return 0 in case of success, else < 0
- \ingroup Slave
+ \ingroup RealtimeInterface
*/
int ecrt_slave_sdo_write_exp16(ec_slave_t *slave, /**< EtherCAT slave */
@@ -636,7 +634,7 @@
/**
Writes a 32-bit SDO in expedited mode.
\return 0 in case of success, else < 0
- \ingroup Slave
+ \ingroup RealtimeInterface
*/
int ecrt_slave_sdo_write_exp32(ec_slave_t *slave, /**< EtherCAT slave */
@@ -652,6 +650,8 @@
/*****************************************************************************/
+/** \cond */
+
EXPORT_SYMBOL(ecrt_slave_sdo_read_exp8);
EXPORT_SYMBOL(ecrt_slave_sdo_read_exp16);
EXPORT_SYMBOL(ecrt_slave_sdo_read_exp32);
@@ -660,4 +660,6 @@
EXPORT_SYMBOL(ecrt_slave_sdo_write_exp32);
EXPORT_SYMBOL(ecrt_slave_sdo_read);
-/*****************************************************************************/
+/** \endcond */
+
+/*****************************************************************************/