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

Merge pull request #9302 from miri64/gnrc_netreg/doc/enhance-register-pre

Browse Source 
gnrc_netreg: Further specify gnrc_netreg_register() precondition
This commit is contained in:
Cenk Gündoğan 2018-06-06 22:41:23 +02:00 committed by GitHub
commit 4ddbf43226
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
sys/include/net/gnrc/netreg.h
View File

@ -305,7 +305,9 @@ static inline void gnrc_netreg_entry_init_cb(gnrc_netreg_entry_t *entry,
* @warning Call gnrc_netreg_unregister() *before* you leave the context you * @warning Call gnrc_netreg_unregister() *before* you leave the context you
* allocated @p entry in. Otherwise it might get overwritten. * allocated @p entry in. Otherwise it might get overwritten.
* *
* @pre The calling thread must provide a message queue. * @pre The calling thread must provide a [message queue](@ref msg_init_queue)
* when using @ref GNRC_NETREG_TYPE_DEFAULT for gnrc_netreg_entry_t::type
* of @p entry.
* *
* @return 0 on success * @return 0 on success
* @return -EINVAL if @p type was < GNRC_NETTYPE_UNDEF or >= GNRC_NETTYPE_NUMOF * @return -EINVAL if @p type was < GNRC_NETTYPE_UNDEF or >= GNRC_NETTYPE_NUMOF