From 723a9d66f4ff3afcb411109002e25e7b290dea2a Mon Sep 17 00:00:00 2001
From: Florian Pose <fp@igh.de>
Date: Mon, 26 Jan 2009 11:58:35 +0000
Subject: [PATCH] merge -c1610 branches/stable-1.4: Added missing doxygen docs.

---
 master/master.c       |  4 ++++
 master/module.c       |  4 +++-
 master/pdo.c          | 18 ++++++++++++------
 master/sdo_request.c  |  4 ++--
 master/slave_config.c |  6 ++++++
 5 files changed, 27 insertions(+), 9 deletions(-)

diff --git a/master/master.c b/master/master.c
index 863e8996..cf992a9e 100644
--- a/master/master.c
+++ b/master/master.c
@@ -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)
diff --git a/master/module.c b/master/module.c
index d9bcdd19..3eff5696 100644
--- a/master/module.c
+++ b/master/module.c
@@ -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;
 
diff --git a/master/pdo.c b/master/pdo.c
index eb52efbf..aff4b177 100644
--- a/master/pdo.c
+++ b/master/pdo.c
@@ -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;
diff --git a/master/sdo_request.c b/master/sdo_request.c
index cfe58aa1..1670505a 100644
--- a/master/sdo_request.c
+++ b/master/sdo_request.c
@@ -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;
diff --git a/master/slave_config.c b/master/slave_config.c
index fc4b0864..30f176f5 100644
--- a/master/slave_config.c
+++ b/master/slave_config.c
@@ -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)
 {