Martine Lenders
aba75be827
netdev: fix return value and precondition doc ...
While reviewing #9942 I noticed that the documentation on the netdev
driver API is unclear and in some cases outright contradicting itself:
> ```
> @return number of bytes used from @p value
> @return `< 0` on error, 0 on success
> ```
IMHO this is unacceptable for such a central API where communication
This fixes a few things and also clarifies preconditions:
- Specifies negative `errno`s clearly so all drivers return the same
when required
- Re-iterates parameter preconditions and special cases within the
parameter documentation itself (might also help towards #9805?)
- Fixes contradictions within return value documentation
- Adds missing parameter documentation on `init()`.
2018-10-03 16:09:42 +02:00
2017-07-03 20:43:51 +02:00
2018-10-03 16:09:42 +02:00
2018-09-21 08:31:09 +02:00
2018-02-17 00:04:54 +01:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2017-09-01 15:12:20 +02:00
2018-08-27 11:32:20 +02:00
2017-09-01 09:37:31 +02:00
2018-07-25 12:01:38 +02:00
2018-07-17 11:15:12 +02:00
2018-07-17 10:02:36 +02:00
2018-08-24 15:47:24 +02:00
2018-07-25 12:01:40 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-05-24 19:16:52 +02:00
2018-03-06 14:00:31 +01:00
2018-08-27 11:32:20 +02:00
2017-09-01 15:12:20 +02:00
2018-07-25 12:01:40 +02:00
2017-09-01 15:12:20 +02:00
2017-09-01 15:12:20 +02:00
2018-07-17 19:19:15 +02:00
2017-09-01 15:12:20 +02:00
2018-08-22 10:54:25 +02:00
2017-09-01 15:12:20 +02:00
2017-09-01 15:12:20 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2017-09-01 15:12:20 +02:00
2018-08-27 11:32:20 +02:00
2017-09-01 15:12:20 +02:00
2018-08-27 11:32:20 +02:00
2018-01-30 21:43:07 +01:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-07-25 12:01:38 +02:00
2018-08-27 11:32:20 +02:00
2017-12-20 14:26:26 +01:00
2018-08-27 11:32:20 +02:00
2018-01-15 17:48:27 +01:00
2017-09-01 15:12:20 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2017-06-21 17:05:45 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-08-02 15:52:58 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2017-09-01 15:12:20 +02:00
2017-11-27 23:52:15 +01:00
2017-09-01 15:12:20 +02:00
2018-05-14 15:05:24 +02:00
2017-09-01 15:12:20 +02:00
2017-08-30 09:06:03 +02:00
2017-11-28 18:31:43 +01:00
2017-09-01 15:12:20 +02:00
2017-09-01 15:12:20 +02:00
2017-09-01 15:12:20 +02:00
2018-06-26 13:46:37 -07:00
2017-09-01 15:12:20 +02:00
2018-08-27 11:32:20 +02:00
2017-09-01 15:12:20 +02:00
2018-01-18 10:46:54 +01:00
2018-06-26 13:46:37 -07:00
2017-11-28 18:31:43 +01:00
2017-09-01 15:12:20 +02:00
2018-06-27 08:58:00 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-01-08 11:51:24 +01:00
2018-03-20 20:09:55 +01:00
2018-07-25 12:01:38 +02:00
2018-09-20 15:18:49 +02:00
2018-07-25 12:01:40 +02:00
2018-09-25 22:22:13 +02:00
2018-08-27 11:32:20 +02:00
2018-06-11 19:10:40 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2018-08-27 11:32:20 +02:00
2017-07-02 23:21:36 +02:00
2017-09-01 15:12:20 +02:00
aba75be827