core: doc: documentation improvement lifo.h lpm.h msg.h mutex.h #962
Conversation
| void mutex_wait(struct mutex_t *mutex); | ||
|
|
||
| /*struct mutex_entry_t * mutex_create_entry(int prio, struct tcb *proc);*/ | ||
|
|
There was a problem hiding this comment.
Since noone used those, so I allowed myself to remove those and put mutex_wait() to mutex.c
| * a value twice the LIFO will break. | ||
| * @file lifo.h | ||
| * @brief LIFO buffer API, read long description carefully | ||
| * @author Heiko Will <[email protected]> |
There was a problem hiding this comment.
core/lifo.c was authored by him according to doc, so I took an educated guess that this would be the case here, too. ;-)
There was a problem hiding this comment.
Weird. lifo.c and lifo.h was only introduced in µkleos and Heiko never contributed to that AFAIK. @kaspar030, what do you think/remember?
There was a problem hiding this comment.
Okay, that should settle this.
|
Addressed @OlegHahm's comments |
| @@ -95,13 +96,15 @@ int msg_send_to_self(msg_t *m); | |||
| /** | |||
| * @brief Send message from interrupt. | |||
| * | |||
| * Will be automatically chosen instead of msg_send if inISR() == true | |||
| * Will be automatically chosen instead of ``msg_sennd()`` if called from an | |||
|
msg.h L85 still contains |
| * @param num Number of msg objects in array. MUST BE POWER OF TWO! | ||
| * @param[in] array Pointer to preallocated array of ``msg_t`` structures, must | ||
| * not be NULL. | ||
| * @param[in] num Number of ``msg_t`` structurs in array. |
There was a problem hiding this comment.
s/structurs/structures/g
|
Applied @thomaseichinger's comments and rebased to master |
|
ACK |
| * @detail This LIFO implementation very efficiently handles integer values. | ||
| * The caveat is that it **can only handle values between 0 and its own | ||
| * size - 1**. Also it can only handle up to one element of each value. | ||
| * If you insert a value twice the LIFO will break. |
There was a problem hiding this comment.
How about tagging this last line as @note?
|
The usage of fullstops look rather arbitrary. |
|
|
||
| #include "queue.h" | ||
|
|
||
| /** | ||
| * @brief Mutex structure. Should never be modified by the user. | ||
| * @brief Mutex structure. Must never be modified by the user. |
|
ACK when my last comments are addressed. |
|
If you mean linebreaks: They are always such that length of line < 80 and that there are only linebreaks at a whitespace |
|
I was referring the usage of |
|
Addressed @OlegHahm's comments and rebased. |
|
looks good to me. Do we need a reACK form @OlegHahm? |
|
Travis faild because of a |
|
Done and rebased |
|
ACK and go. |
core: doc: documentation improvement lifo.h lpm.h msg.h mutex.h
Fixes #953