Skip to content
Snippets Groups Projects
Commit 544037e8 authored by Florian Pose's avatar Florian Pose
Browse files

Added api doc.

parent aa76ae64
No related branches found
No related tags found
No related merge requests found
......@@ -1128,7 +1128,12 @@ ec_voe_handler_t *ecrt_slave_config_create_voe_handler(
/** Outputs the state of the slave configuration.
*
* Stores the state information in the given \a state structure.
* Stores the state information in the given \a state structure. The state
* information is updated by the master state machine, so it may take a few
* cycles, until it changes.
*
* \attention If the state of process data exchange shall be monitored in
* realtime, ecrt_domain_state() should be used.
*/
void ecrt_slave_config_state(
const ec_slave_config_t *sc, /**< Slave configuration */
......@@ -1244,6 +1249,8 @@ void ecrt_domain_queue(
/** Reads the state of a domain.
*
* Stores the domain state in the given \a state structure.
*
* Using this method, the process data exchange can be monitored in realtime.
*/
void ecrt_domain_state(
const ec_domain_t *domain, /**< Domain. */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment