# HG changeset patch # User Florian Pose # Date 1326186746 -3600 # Node ID 13ef066f37d359d1b267d2ec0ec845df4cb45d47 # Parent b45438edf86993c462aa11f21c2c329367ebed74 Improved docs. diff -r b45438edf869 -r 13ef066f37d3 include/ecrt.h --- a/include/ecrt.h Mon Jan 09 17:42:28 2012 +0100 +++ b/include/ecrt.h Tue Jan 10 10:12:26 2012 +0100 @@ -1,6 +1,6 @@ /****************************************************************************** * - * $Id: ecrt.h,v ebda087981e1 2011/09/15 13:58:58 fp $ + * $Id$ * * Copyright (C) 2006-2008 Florian Pose, Ingenieurgemeinschaft IgH * @@ -81,7 +81,6 @@ * - Added support for overlapping PDOs which allows inputs to use the same * space as outputs on the frame. This reduces the frame length. * - * * @{ */ @@ -175,9 +174,11 @@ /** Master state. * - * This is used for the output parameter of ecrt_master_state(). + * This is used for the output parameter of ecrt_master_state() and + * ecrt_master_configured_slaves_state(). * * \see ecrt_master_state(). + * \see ecrt_master_configured_slaves_state(). */ typedef struct { unsigned int slaves_responding; /**< Number of slaves in the bus. */ @@ -491,7 +492,7 @@ #ifdef __KERNEL__ /** Attach to a running master - * + * * This function returns the master handle for the RTDM-Interface * * \return Pointer to the opened master, otherwise \a NULL. @@ -541,16 +542,17 @@ /** Returns domain structure pointer * + * \fixme The application knows the domain pointers! + * * This functions return the domain structure pointer for usage inside the * RTDM-Interface. * * \return Pointer to the domain on success, else NULL. */ ec_domain_t *ecrt_master_find_domain( - ec_master_t *master, + ec_master_t *master, unsigned int index); - #endif /* __KERNEL__ */ #ifndef __KERNEL__ @@ -879,9 +881,10 @@ /** Reads the current master state and the al_state of all configured slaves. * - * use this function instead of ecrt_master_state if there are unused - * slaves on the bus - * Stores the master state information in the given \a state structure. + * Use this function instead of ecrt_master_state() if there are unused slaves + * on the bus. Stores the master state information in the given \a state + * structure. + * * \see ecrt_master_state() */ void ecrt_master_configured_slaves_state(