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, 26 insertions, 0 deletions

diff --git a/os/hal/platforms/AVR/serial_lld.c b/os/hal/platforms/AVR/serial_lld.c
index 8512fb873..74f8c63b4 100644
--- a/os/hal/platforms/AVR/serial_lld.c
+++ b/os/hal/platforms/AVR/serial_lld.c
@@ -149,6 +149,11 @@ static void usart1_deinit(void) {
 /*===========================================================================*/

 

 #if USE_AVR_USART0 || defined(__DOXYGEN__)

+/**

+ * @brief   USART0 RX interrupt handler.

+ *

+ * @isr
+ */

 CH_IRQ_HANDLER(USART0_RX_vect) {

   uint8_t sra;

 

@@ -164,6 +169,11 @@ CH_IRQ_HANDLER(USART0_RX_vect) {
   CH_IRQ_EPILOGUE();

 }

 

+/**

+ * @brief   USART0 TX interrupt handler.

+ *

+ * @isr
+ */

 CH_IRQ_HANDLER(USART0_UDRE_vect) {

   msg_t b;

 

@@ -182,6 +192,11 @@ CH_IRQ_HANDLER(USART0_UDRE_vect) {
 #endif /* USE_AVR_USART0 */

 

 #if USE_AVR_USART1 || defined(__DOXYGEN__)

+/**

+ * @brief   USART1 RX interrupt handler.

+ *

+ * @isr
+ */

 CH_IRQ_HANDLER(USART1_RX_vect) {

   uint8_t sra;

 

@@ -197,6 +212,11 @@ CH_IRQ_HANDLER(USART1_RX_vect) {
   CH_IRQ_EPILOGUE();

 }

 

+/**

+ * @brief   USART1 TX interrupt handler.

+ *

+ * @isr
+ */

 CH_IRQ_HANDLER(USART1_UDRE_vect) {

   msg_t b;

 

@@ -220,6 +240,8 @@ CH_IRQ_HANDLER(USART1_UDRE_vect) {
 

 /**

  * @brief   Low level serial driver initialization.

+ *

+ * @notapi

  */

 void sd_lld_init(void) {

 

@@ -238,6 +260,8 @@ void sd_lld_init(void) {
  * @param[in] config    the architecture-dependent serial driver configuration.

  *                      If this parameter is set to @p NULL then a default

  *                      configuration is used.

+ *

+ * @notapi

  */

 void sd_lld_start(SerialDriver *sdp, const SerialConfig *config) {

 

@@ -264,6 +288,8 @@ void sd_lld_start(SerialDriver *sdp, const SerialConfig *config) {
  *          interrupt vector.

  *

  * @param[in] sdp       pointer to a @p SerialDriver object

+ *

+ * @notapi

  */

 void sd_lld_stop(SerialDriver *sdp) {