# HG changeset patch
# User Florian Pose <fp@igh-essen.com>
# Date 1207563973 0
# Node ID ee1b25db1fbf49e9ab62559eb6cb034acc069a18
# Parent  eaa10a277d525421bc7c802f3d70bb1021a0b844
Added a few docs.

diff -r eaa10a277d52 -r ee1b25db1fbf include/ecrt.h
--- a/include/ecrt.h	Mon Apr 07 10:19:59 2008 +0000
+++ b/include/ecrt.h	Mon Apr 07 10:26:13 2008 +0000
@@ -649,9 +649,12 @@
         ec_domain_t *domain /**< Domain. */
         );
 
-/** Processes received datagrams.
- *
- * \todo doc
+/** Determines the states of the domain's datagrams.
+ *
+ * Evaluates the working counters of the received datagrams and outputs
+ * statistics, if necessary. This must be called after ecrt_master_receive()
+ * is expected to receive the domain datagrams in order to make
+ * ecrt_domain_state() return the result of the last process data exchange.
  */
 void ecrt_domain_process(
         ec_domain_t *domain /**< Domain. */
@@ -659,7 +662,8 @@
 
 /** (Re-)queues all domain datagrams in the master's datagram queue.
  *
- * \todo doc
+ * Call this function to mark the domain's datagrams for exchanging at the
+ * next call of ecrt_master_send().
  */
 void ecrt_domain_queue(
         ec_domain_t *domain /**< Domain. */
@@ -667,7 +671,7 @@
 
 /** Reads the state of a domain.
  *
- * Stores the domain state in the giveb \a state structure.
+ * Stores the domain state in the given \a state structure.
  */
 void ecrt_domain_state(
         const ec_domain_t *domain, /**< Domain. */