Skip to content
Snippets Groups Projects
Commit 77964e8a authored by Hinnerk van Bruinehsen's avatar Hinnerk van Bruinehsen
Browse files

Merge pull request #1928 from authmillenon/netdev-fix-doc

netdev: clarify documentation of netdev_driver_t::get_option()
parents 9d74d6b1 038beb0f
Branches
No related tags found
No related merge requests found
...@@ -252,12 +252,13 @@ typedef struct { ...@@ -252,12 +252,13 @@ typedef struct {
* @param[in] opt the option type * @param[in] opt the option type
* @param[out] value pointer to store the gotten value in * @param[out] value pointer to store the gotten value in
* @param[in,out] value_len the length of *value*. Must be initialized to the * @param[in,out] value_len the length of *value*. Must be initialized to the
* available space in value on call. * available space in *value* on call.
* @return 0, on success * @return 0, on success
* @return -ENODEV, if *dev* is not recognized * @return -ENODEV, if *dev* is not recognized
* @return -ENOTSUP, if *opt* is not supported for the device with this * @return -ENOTSUP, if *opt* is not supported for the device with this
* operation * operation
* @return -EOVERFLOW, if length of *value* is longer then *value_len*. * @return -EOVERFLOW, if available space in *value* given in *value_len*
* is not big enough to store the option value.
* @return any other fitting negative errno if the ones stated above * @return any other fitting negative errno if the ones stated above
* are not sufficient * are not sufficient
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment