Documentation improvements, fixed a small error in the STM32 serial driver.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2234 35acf78f-673a-0410-8e92-d51de3d6d3f4

1 files changed, 33 insertions, 7 deletions

diff --git a/os/hal/platforms/STM32/can_lld.c b/os/hal/platforms/STM32/can_lld.c
index 7b390bb7e..526ecb98e 100644
--- a/os/hal/platforms/STM32/can_lld.c
+++ b/os/hal/platforms/STM32/can_lld.c
@@ -51,8 +51,10 @@ CANDriver CAND1;
 /* Driver interrupt handlers.                                                */

 /*===========================================================================*/

 

-/*

- * CAN1 TX interrupt handler.

+/**

+ * @brief   CAN1 TX interrupt handler.

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(CAN1_TX_IRQHandler) {

 

@@ -70,7 +72,9 @@ CH_IRQ_HANDLER(CAN1_TX_IRQHandler) {
 }

 

 /*

- * CAN1 RX0 interrupt handler.

+ * @brief   CAN1 RX0 interrupt handler.

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(CAN1_RX0_IRQHandler) {

   uint32_t rf0r;

@@ -99,8 +103,10 @@ CH_IRQ_HANDLER(CAN1_RX0_IRQHandler) {
   CH_IRQ_EPILOGUE();

 }

 

-/*

- * CAN1 RX1 interrupt handler.

+/**

+ * @brief   CAN1 RX1 interrupt handler.

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(CAN1_RX1_IRQHandler) {

 

@@ -111,8 +117,10 @@ CH_IRQ_HANDLER(CAN1_RX1_IRQHandler) {
   CH_IRQ_EPILOGUE();

 }

 

-/*

- * CAN1 SCE interrupt handler.

+/**

+ * @brief   CAN1 SCE interrupt handler.

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(CAN1_SCE_IRQHandler) {

   uint32_t msr;

@@ -151,6 +159,8 @@ CH_IRQ_HANDLER(CAN1_SCE_IRQHandler) {
 

 /**

  * @brief   Low level CAN driver initialization.

+ *

+ * @notapi

  */

 void can_lld_init(void) {

 

@@ -169,6 +179,8 @@ void can_lld_init(void) {
  * @brief   Configures and activates the CAN peripheral.

  *

  * @param[in] canp      pointer to the @p CANDriver object

+ *

+ * @notapi

  */

 void can_lld_start(CANDriver *canp) {

 

@@ -253,6 +265,8 @@ void can_lld_start(CANDriver *canp) {
  * @brief   Deactivates the CAN peripheral.

  *

  * @param[in] canp      pointer to the @p CANDriver object

+ *

+ * @notapi

  */

 void can_lld_stop(CANDriver *canp) {

 

@@ -280,6 +294,8 @@ void can_lld_stop(CANDriver *canp) {
  * @return The queue space availability.

  * @retval FALSE        no space in the transmit queue.

  * @retval TRUE         transmit slot available.

+ *

+ * @notapi

  */

 bool_t can_lld_can_transmit(CANDriver *canp) {

 

@@ -291,6 +307,8 @@ bool_t can_lld_can_transmit(CANDriver *canp) {
  *

  * @param[in] canp      pointer to the @p CANDriver object

  * @param[in] ctfp      pointer to the CAN frame to be transmitted

+ *

+ * @notapi

  */

 void can_lld_transmit(CANDriver *canp, const CANTxFrame *ctfp) {

   uint32_t tir;

@@ -319,6 +337,8 @@ void can_lld_transmit(CANDriver *canp, const CANTxFrame *ctfp) {
  * @return The queue space availability.

  * @retval FALSE        no space in the transmit queue.

  * @retval TRUE         transmit slot available.

+ *

+ * @notapi

  */

 bool_t can_lld_can_receive(CANDriver *canp) {

 

@@ -330,6 +350,8 @@ bool_t can_lld_can_receive(CANDriver *canp) {
  *

  * @param[in] canp      pointer to the @p CANDriver object

  * @param[out] crfp     pointer to the buffer where the CAN frame is copied

+ *

+ * @notapi

  */

 void can_lld_receive(CANDriver *canp, CANRxFrame *crfp) {

   uint32_t r;

@@ -363,6 +385,8 @@ void can_lld_receive(CANDriver *canp, CANRxFrame *crfp) {
  * @brief   Enters the sleep mode.

  *

  * @param[in] canp      pointer to the @p CANDriver object

+ *

+ * @notapi

  */

 void can_lld_sleep(CANDriver *canp) {

 

@@ -373,6 +397,8 @@ void can_lld_sleep(CANDriver *canp) {
  * @brief   Enforces leaving the sleep mode.

  *

  * @param[in] canp      pointer to the @p CANDriver object

+ *

+ * @notapi

  */

 void can_lld_wakeup(CANDriver *canp) {