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

diff --git a/os/hal/templates/can_lld.c b/os/hal/templates/can_lld.c
index 65190276d..dca401bd4 100644
--- a/os/hal/templates/can_lld.c
+++ b/os/hal/templates/can_lld.c
@@ -52,6 +52,8 @@
 

 /**

  * @brief   Low level CAN driver initialization.

+ *

+ * @notapi

  */

 void can_lld_init(void) {

 

@@ -61,6 +63,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) {

 

@@ -70,6 +74,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) {

 

@@ -87,6 +93,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) {

 

@@ -98,6 +106,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) {

 

@@ -110,6 +120,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) {

 

@@ -121,6 +133,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) {

 

@@ -131,6 +145,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) {

 

@@ -140,6 +156,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) {