Commit fc06f333 authored by Federico Vaga's avatar Federico Vaga

wrtd: fix comment

Signed-off-by: 's avatarFederico Vaga <federico.vaga@gmail.com>
parent 1b9789e9
...@@ -30,7 +30,7 @@ const char *wrtd_errors[] = { ...@@ -30,7 +30,7 @@ const char *wrtd_errors[] = {
/** /**
* It returns a string messages corresponding to a given error code. If * It returns a string messages corresponding to a given error code. If
* it is not a libwrtd error code, it will run strerror(3) * it is not a libwrtd error code, it will run wrnc_strerror()
* @param[in] err error code * @param[in] err error code
* @return a message error * @return a message error
*/ */
...@@ -67,7 +67,7 @@ int wrtd_init() ...@@ -67,7 +67,7 @@ int wrtd_init()
/** /**
* It releases the resources allocated by wrtd_init(). It must be called when * It releases the resources allocated by wrtd_init(). It must be called when
* you stop to use this library. Then, you cannot use functions from this * you stop to use this library. Then, you cannot use functions from this
* library * library.
*/ */
void wrtd_exit() void wrtd_exit()
{ {
...@@ -76,7 +76,7 @@ void wrtd_exit() ...@@ -76,7 +76,7 @@ void wrtd_exit()
/** /**
* Open a WRTD node device using LUN * Open a WRTD node device using FMC ID
* @param[in] device_id FMC device identificator * @param[in] device_id FMC device identificator
* @return It returns an anonymous wrtd_node structure on success. * @return It returns an anonymous wrtd_node structure on success.
* On error, NULL is returned, and errno is set appropriately. * On error, NULL is returned, and errno is set appropriately.
...@@ -144,7 +144,8 @@ void wrtd_close(struct wrtd_node *dev) ...@@ -144,7 +144,8 @@ void wrtd_close(struct wrtd_node *dev)
/** /**
* It returns the WRNC token * It returns the WRNC token in order to allows users to run
* functions from the WRNC library
* @param[in] dev device token * @param[in] dev device token
* @return the WRNC token * @return the WRNC token
*/ */
......
...@@ -206,11 +206,12 @@ extern int wrtd_out_enable(struct wrtd_node *dev, unsigned int output, ...@@ -206,11 +206,12 @@ extern int wrtd_out_enable(struct wrtd_node *dev, unsigned int output,
/** /**
* It assign a trigger to an output channel
* @param[in] dev pointer to open node device. * @param[in] dev pointer to open node device.
* @param[in] output index (0-based) of output channel * @param[in] output index (0-based) of output channel
* @param[out] handle * @param[out] handle
* @param[in] trig trigger id to assign * @param[in] trig trigger id to assign
* @param[in] condition * @param[in] condition trigger id to assign to the condition
* @return 0 on success, -1 on error and errno is set appropriately * @return 0 on success, -1 on error and errno is set appropriately
*/ */
extern int wrtd_out_trig_assign(struct wrtd_node *dev, int output, extern int wrtd_out_trig_assign(struct wrtd_node *dev, int output,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment