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

2 files changed, 15 insertions, 0 deletions

diff --git a/os/hal/platforms/SPC56x/hal_lld.c b/os/hal/platforms/SPC56x/hal_lld.c
index c5d15dcfa..a855a70a2 100644
--- a/os/hal/platforms/SPC56x/hal_lld.c
+++ b/os/hal/platforms/SPC56x/hal_lld.c
@@ -50,6 +50,8 @@
 

 /**

  * @brief   Low level HAL driver initialization.

+ *

+ * @notapi

  */

 void hal_lld_init(void) {

   extern void _vectors(void);

@@ -107,6 +109,9 @@ void hal_lld_init(void) {
  * @brief   SPC563 clocks and PLL initialization.

  * @note    All the involved constants come from the file @p board.h and

  *          @p hal_lld.h

+ * @note    This function must be invoked only after the system reset.

+ *

+ * @special

  */

 void spc563_clock_init(void) {

 

diff --git a/os/hal/platforms/SPC56x/serial_lld.c b/os/hal/platforms/SPC56x/serial_lld.c
index c99146d02..363381750 100644
--- a/os/hal/platforms/SPC56x/serial_lld.c
+++ b/os/hal/platforms/SPC56x/serial_lld.c
@@ -215,6 +215,8 @@ static void notify2(void) {
 #if USE_SPC563_ESCIA || defined(__DOXYGEN__)

 /**

  * @brief   eSCI-A interrupt handler.

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(vector146) {

 

@@ -229,6 +231,8 @@ CH_IRQ_HANDLER(vector146) {
 #if USE_SPC563_ESCIB || defined(__DOXYGEN__)

 /**

  * @brief   eSCI-B interrupt handler.

+ *

+ * @isr

  */

 CH_IRQ_HANDLER(vector149) {

 

@@ -246,6 +250,8 @@ CH_IRQ_HANDLER(vector149) {
 

 /**

  * @brief   Low level serial driver initialization.

+ *

+ * @notapi

  */

 void sd_lld_init(void) {

 

@@ -271,6 +277,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) {

 

@@ -283,6 +291,8 @@ void sd_lld_start(SerialDriver *sdp, const SerialConfig *config) {
  * @brief   Low level serial driver stop.

  *

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

+ *

+ * @notapi

  */

 void sd_lld_stop(SerialDriver *sdp) {