core: kernel: improved doxygen documentation #977
Conversation
mehlis
changed the title
| /** | ||
| * @def PRIORITY_MIN | ||
| * @brief Minimal priority a thread can have | ||
| */ | ||
| #define PRIORITY_MIN SCHED_PRIO_LEVELS-1 |
There was a problem hiding this comment.
Please put this in parens while you're at it.
|
@ALL I need help to document some defines in |
| #define PRIORITY_MAIN (PRIORITY_MIN - (SCHED_PRIO_LEVELS/2)) | ||
|
|
||
| /** | ||
| * @def LPM_PREVENT_SLEEP_UART | ||
| * @brief ??? |
There was a problem hiding this comment.
e.g. @brief Bitmask to use with lpm_prevent_sleep in power management.
|
@OlegHahm can you review? |
| extern volatile int lpm_prevent_sleep; | ||
|
|
||
| /** | ||
| * @brief Variable sysconfig defined externally |
There was a problem hiding this comment.
I don't think there's a reason to say that it is defined externally:
1.) It should be obvious that one does not define variables in header files.
2.) It says extern one line below.
The sysconfig variable however is used to store system configuration (like node's ID, name, default channel and so on.)
|
Anything else were you need help? |
|
updated, rebased, please review again, PR is mergeable from my side |
|
I commented on the commit again. -_- Sorry. |
|
@Kijewski noooo, but I can show you how it works, again :) |
|
ACK |
|
Still WIP? |
|
Please amend disableIRQ() and enableIRQ(): The return value should not interpreted as a boolean value. The actual value is only significant for restoreIRQ(). |
|
Otherwise the files look good. 👍 |
|
@Kijewski what do you want me to change? can we merge this now? |
|
I think what @Kijewski means is to mention in the docs that the return values of Otherwise I think you are good to go. |
|
@Kijewski & @thomaseichinger updated to match your comments |
also added param[in] to irq.h and fix order of doxygen endguards
|
ACK & GO |
core: kernel: improved doxygen documentation
there is no doxygen warning for this file