RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
Code Releases Activity

ng_netdev: fix documentation

Browse Source
This commit is contained in:
Martine Lenders 2015-02-13 12:40:14 +01:00
parent 0b95b3ae40
commit 580eb63835
2 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sys/include/net/ng_netconf.h
View File

@ -10,7 +10,7 @@
* @defgroup net_ng_netconf Configuration options for network APIs
* @ingroup net
* @brief List of available configuration options for the
* @ref net_netdev and the @ref net_ng_netapi
* @ref net_ng_netdev and the @ref net_ng_netapi
* @{
*
* @file

35
sys/include/net/ng_netdev.h
View File

@ -8,7 +8,7 @@
*/
/**
* @defgroup net_netdev Network device driver interface
* @defgroup net_ng_netdev Network device driver interface
* @ingroup net
* @{
*
@ -59,7 +59,10 @@ typedef enum {
typedef void (*ng_netdev_event_cb_t)(ng_netdev_event_t type, void *arg);
/**
* @brief Forward declaration of *ng_netdev_t*
* @brief Forward declaration of ng_netdev_t due to cyclic dependency to
* @ref ng_netdev_driver_t.
*
* @see ng_netdev
*/
typedef struct ng_netdev ng_netdev_t;
@ -77,7 +80,7 @@ typedef struct {
* @param[in] pkt pointer to the data in the packet buffer
*
* @return number of bytes that were actually send out
* @return -ENODEV if *dev* is invalid
* @return -ENODEV if @p dev is invalid
* @return -ENOMSG if pkt is invalid
*/
int (*send_data)(ng_netdev_t *dev, ng_pktsnip_t *pkt);
@ -89,7 +92,7 @@ typedef struct {
* @param[in] cb function that is called on events
*
* @return 0 on success
* @return -ENODEV if *dev* is invalid
* @return -ENODEV if @p dev is invalid
* @return -ENOBUFS if maximum number of callbacks is exceeded
*/
int (*add_event_callback)(ng_netdev_t *dev, ng_netdev_event_cb_t cb);
@ -101,7 +104,7 @@ typedef struct {
* @param[in] cb callback function
*
* @return 0 on success
* @return -ENODEV if *dev* is invalid
* @return -ENODEV if @p dev is invalid
* @return -ENOPKG if callback was not registered
*/
int (*rem_event_callback)(ng_netdev_t *dev, ng_netdev_event_cb_t cb);
@ -112,14 +115,14 @@ typedef struct {
* @param[in] dev network device descriptor
* @param[in] opt option type
* @param[out] value pointer to store the option's value in
* @param[in,out] value_len the length of *value*. Must be initialized to
* the available space in *value* on call.
* @param[in,out] value_len the length of @p value. Must be initialized to
* the available space in @p value on call.
*
* @return 0 on success
* @return -ENODEV if *dev* is invalid
* @return -ENOTSUP if *opt* is not supported
* @return -EOVERFLOW if available space in *value* given in
* *value_len* is too small to store the option value
* @return -ENODEV if @p dev is invalid
* @return -ENOTSUP if @p opt is not supported
* @return -EOVERFLOW if available space in @p value given in
* @p value_len is too small to store the option value
*/
int (*get)(ng_netdev_t *dev, ng_netconf_opt_t opt,
void *value, size_t *value_len);
@ -130,12 +133,12 @@ typedef struct {
* @param[in] dev network device descriptor
* @param[in] opt option type
* @param[in] value value to set
* @param[in] value_len the length of *value*
* @param[in] value_len the length of @p value
*
* @return 0 on success
* @return -ENODEV if *dev* is invalid
* @return -ENOTSUP if *opt* is not supported
* @return -EINVAL if *value* is invalid
* @return -ENODEV if @p dev is invalid
* @return -ENOTSUP if @p opt is not supported
* @return -EINVAL if @p value is invalid
*/
int (*set)(ng_netdev_t *dev, ng_netconf_opt_t opt,
void *value, size_t value_len);
@ -157,6 +160,8 @@ typedef struct {
* specific fields
*
* The netdev structure is the parent for all network device driver descriptors.
*
* @see ng_netdev_t
*/
struct ng_netdev {
ng_netdev_driver_t *driver; /**< pointer to the devices interface */