From: marco <marco@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Wed, 7 Nov 2007 22:25:54 +0000 (+0000)
Subject: Fixed documentation typos and put ascii tables in verbatim block
X-Git-Tag: 1.0.0~250
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=0085ab8f553274e9d7187ad09146972af3c7ea47;p=bertos.git

Fixed documentation typos and put ascii tables in verbatim block

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@992 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/drv/tc520.c b/drv/tc520.c
index 3b61ad55..615a94e0 100644
--- a/drv/tc520.c
+++ b/drv/tc520.c
@@ -55,10 +55,14 @@ static Serial *spi_ser;
 
 /**
  * Start an AD conversion and return result.
+ *
  * To start a conversion first we must pull down CE pin.
  * The ADC starts a convertion and keeps the DV pin high until the end.
  * At this point, we can read the conversion value by SPI.
  * The convertion result is yield in 3 bytes.
+ *
+ * \verbatim
+ *
  * First byte:
  * bit | Value
  * ----|-------
@@ -75,8 +79,10 @@ static Serial *spi_ser;
  *  6  | data bit 0
  * 5:0 | '0'
  *
+ * \endverbatim
+ *
  * So, to get the result we must shift and recompose the bits.
- * \Note Ovverrange bit is handled as the 17th data bit.
+ * \note Overrange bit is handled as the 17th data bit.
  */
 tc520_data_t tc520_read(void)
 {