merge -c1610 branches/stable-1.4: Added missing doxygen docs.

This commit is contained in:
Florian Pose 2009-01-26 11:58:35 +00:00
parent 775bd4d7ee
commit 723a9d66f4
5 changed files with 27 additions and 9 deletions

View File

@ -1307,6 +1307,8 @@ int ec_master_debug_level(
* Realtime interface
*****************************************************************************/
/** Same as ecrt_master_create_domain(), but with ERR_PTR() return value.
*/
ec_domain_t *ecrt_master_create_domain_err(
ec_master_t *master /**< master */
)
@ -1484,6 +1486,8 @@ void ecrt_master_receive(ec_master_t *master)
/*****************************************************************************/
/** Same as ecrt_master_slave_config(), but with ERR_PTR() return value.
*/
ec_slave_config_t *ecrt_master_slave_config_err(ec_master_t *master,
uint16_t alias, uint16_t position, uint32_t vendor_id,
uint32_t product_code)

View File

@ -462,7 +462,9 @@ ec_device_t *ecdev_offer(
*
* Same as ecrt_request_master(), but with ERR_PTR() return value.
*/
ec_master_t *ecrt_request_master_err(unsigned int master_index)
ec_master_t *ecrt_request_master_err(
unsigned int master_index /**< Master index. */
)
{
ec_master_t *master, *errptr = NULL;

View File

@ -56,7 +56,10 @@ void ec_pdo_init(
* \retval 0 Success.
* \retval <0 Error code.
*/
int ec_pdo_init_copy(ec_pdo_t *pdo, const ec_pdo_t *other_pdo)
int ec_pdo_init_copy(
ec_pdo_t *pdo, /**< PDO to create. */
const ec_pdo_t *other_pdo /**< PDO to copy from. */
)
{
int ret = 0;
@ -149,10 +152,10 @@ int ec_pdo_set_name(
* \retval Pointer to the added entry, otherwise a ERR_PTR() code.
*/
ec_pdo_entry_t *ec_pdo_add_entry(
ec_pdo_t *pdo,
uint16_t index,
uint8_t subindex,
uint8_t bit_length
ec_pdo_t *pdo, /**< PDO. */
uint16_t index, /**< New entry's index. */
uint8_t subindex, /**< New entry's subindex. */
uint8_t bit_length /**< New entry's bit length. */
)
{
ec_pdo_entry_t *entry;
@ -177,7 +180,10 @@ ec_pdo_entry_t *ec_pdo_add_entry(
* \retval 0 Success.
* \retval <0 Error code.
*/
int ec_pdo_copy_entries(ec_pdo_t *pdo, const ec_pdo_t *other)
int ec_pdo_copy_entries(
ec_pdo_t *pdo, /**< PDO whos entries shall be replaced. */
const ec_pdo_t *other /**< Pdo with entries to copy. */
)
{
ec_pdo_entry_t *entry, *other_entry;
int ret;

View File

@ -81,8 +81,8 @@ void ec_sdo_request_clear(
* \attention Only the index subindex and data are copied.
*/
int ec_sdo_request_copy(
ec_sdo_request_t *req,
const ec_sdo_request_t *other
ec_sdo_request_t *req, /**< SDO request. */
const ec_sdo_request_t *other /**< Other SDO request to copy from. */
)
{
req->index = other->index;

View File

@ -734,6 +734,9 @@ int ecrt_slave_config_sdo32(ec_slave_config_t *sc, uint16_t index,
/*****************************************************************************/
/** Same as ecrt_slave_config_create_sdo_request(), but with ERR_PTR() return
* value.
*/
ec_sdo_request_t *ecrt_slave_config_create_sdo_request_err(
ec_slave_config_t *sc, uint16_t index, uint8_t subindex, size_t size)
{
@ -784,6 +787,9 @@ ec_sdo_request_t *ecrt_slave_config_create_sdo_request(
/*****************************************************************************/
/** Same as ecrt_slave_config_create_voe_handler(), but with ERR_PTR() return
* value.
*/
ec_voe_handler_t *ecrt_slave_config_create_voe_handler_err(
ec_slave_config_t *sc, size_t size)
{