abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2026-05-27 18:47:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve system abstraction layer doxygen docs by moving documentation from sys_arch.txt to sys.c

Browse Source
This commit is contained in:
Dirk Ziegelmeier
2017-10-17 22:38:18 +02:00
parent 26b2628f01
commit 8a46a853d2
2 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/core/sys.c
View File

@@ -47,6 +47,13 @@
*
* @defgroup sys_sem Semaphores
* @ingroup sys_os
* Semaphores can be either counting or binary - lwIP works with both
* kinds.
* Semaphores are represented by the type "sys_sem_t" which is typedef'd
* in the sys_arch.h file. Mailboxes are equivalently represented by the
* type "sys_mbox_t". Mutexes are represented by the type "sys_mutex_t".
* lwIP does not place any restrictions on how these types are represented
* internally.
*
* @defgroup sys_mutex Mutexes
* @ingroup sys_os
@@ -55,6 +62,10 @@
*
* @defgroup sys_mbox Mailboxes
* @ingroup sys_os
* Mailboxes should be implemented as a queue which allows multiple messages
* to be posted (implementing as a rendez-vous point where only one message can be
* posted at a time can have a highly negative impact on performance). A message
* in a mailbox is just a pointer, nothing more.
*
* @defgroup sys_time Time
* @ingroup sys_layer