1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
RIOT/doc/doxygen
Marian Buschsieweke 4a016adebb
doc/driver-guide.md: Update doc on return value
Change driver guide to expect drivers to return negative errno codes instead of
enums for error codes. Those have the following advantages:

- More efficient implementation of POSIX compatibility wrappers:
    - In case of error, just an `errno = -retval; return -1` is needed
- Better interoperability
    - A lot of code within RIOT and in external code is doing so already.
      Applying this consistently allows passing error codes through, rather
      than translating between errno codes and custom enum values
- Not reinventing the wheel
    - Defining and documenting custom error codes for each driver is unneeded
      effort
    - The error classes that device driver have to report are largely the same.
      There is no reason to have dozens of error codes for an input/output
      error, each with a unique spelling a programmer needs to memorize
2020-09-22 14:38:56 +02:00
..
src doc/driver-guide.md: Update doc on return value 2020-09-22 14:38:56 +02:00
.gitignore doc: add release notes to doxygen documentation 2017-05-12 17:54:48 +02:00
footer.html doc: utilize smartmenus 2017-04-25 09:35:50 +02:00
generate-changelog.py doc/doxygen: Use python3 in generate-changelog.py 2019-09-10 10:10:12 +02:00
header.html doc/search: do not hide search on mobile and make it work 2020-07-04 15:15:58 +02:00
Makefile doc/doxygen: add package name for lessc 2019-02-20 11:35:06 +01:00
riot.doxyfile doxygen: increase DOT_GRAPH_MAX_NODES 2020-09-02 11:11:29 +02:00
RIOTDoxygenLayout.xml doc: fix trailing whitespace in Doxygen XML 2016-02-21 18:58:02 +01:00