[riot-notifications] [RIOT-OS/RIOT] cpu/esp*: Xtensa vendor code moved to esp_common (#10883)

Sebastian Meiling notifications at github.com
Mon Feb 4 11:26:53 CET 2019


smlng requested changes on this pull request.

mostly doc-related, i.e. use `@name` for groups instead of `@brief` ... though this was overseen when merging the original code.

>  /**
- * @brief   Macros that have to be used on entry into and reset from an ISR
- *
- * NOTE: since they use a local variable they can be used only in same function
+ * @brief   Macros that have to be used on entry into and exit from an ISR
+ * In non-SDK interrupt handling all stuff is done in _frxt_int_enter

add empty line after the `@brief` otherwise this will not be very brief when compiled to HTML

> @@ -89,13 +74,14 @@ extern volatile uint32_t irq_interrupt_nesting;
  */
 #define critical_enter()   int _irq_state = irq_disable ()
 #define critical_exit()    irq_restore(_irq_state)
+/** @} */
 
 /**
  * @brief   Macros to enter and exit from critical region with state variable

groups use `@name` instead of `@brief`

>  /**
- * @brief   Macros that have to be used on entry into and reset from an ISR
- *
- * NOTE: since they use a local variable they can be used only in same function
+ * @brief   Macros that have to be used on entry into and exit from an ISR
+ * In non-SDK interrupt handling all stuff is done in _frxt_int_enter

as below: groups use `@name` not `@brief`

>  #define irq_isr_enter() /* int _irq_state = irq_disable (); \
                            irq_interrupt_nesting++; */
 
 #define irq_isr_exit()  /* if (irq_interrupt_nesting) \
                                irq_interrupt_nesting--; \
                            irq_restore (_irq_state); */
-
-#endif /* SDK_INT_HANDLING */
+/** @} */
 
 /**
  * @brief   Macros to enter and exit from critical region

same here, use `@name`

>  #define irq_isr_enter() /* int _irq_state = irq_disable (); \
                            irq_interrupt_nesting++; */
 
 #define irq_isr_exit()  /* if (irq_interrupt_nesting) \
                                irq_interrupt_nesting--; \
                            irq_restore (_irq_state); */
-
-#endif /* SDK_INT_HANDLING */
+/** @} */
 
 /**
  * @brief   Macros to enter and exit from critical region

and for the NOTE below use `@note` to get a nice green box when compiled to HTML

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/RIOT-OS/RIOT/pull/10883#pullrequestreview-199515339
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190204/bbc20726/attachment.html>


More information about the notifications mailing list