Diff: AD7989.h

Revision:

4:be5656dbc656

Parent:

3:c3f4ce50902f

Child:

5:558b7506e684

diff -r c3f4ce50902f -r be5656dbc656 AD7989.h
--- a/AD7989.h	Mon Jan 21 11:47:01 2019 -0600
+++ b/AD7989.h	Mon Jan 21 19:06:35 2019 +0000
@@ -2,28 +2,10 @@
 #define AD7989_H
 
 #include "mbed.h"
-/** An abstraction for an 18 bit ADC
-*  @note Not quite sure this is thread or interrupt safe. Treat this as a standard mbed SPI object
-*  There are mutex locks when the SPI bus is being used.
-*  Example
-*  @code
-*  #include "mbed.h"
-*  #include "AD7989_Driver.h"
-*
-*  SPI spi(p5, p6, p7); // mosi, miso, sclk
-*  DigitalOut cs(p8);
-*  Digitalout convert(p9);
-*  AD7989_Driver ADCDEV(&spi, &cs, &convert);
-*  double voltage;
-*  int main()
-*  {
-*    while(1)
-*    {
-*      voltage = ADCDEV.sample();
-*      printf("Voltage = %f Volts", voltage);
-*    }
-*  }
-*/
+    /** An abstraction for an 18 bit ADC
+    *  @note Not quite sure this is thread or interrupt safe. Treat this as a standard mbed SPI object
+    *  There are mutex locks when the SPI bus is being used.
+    */
 class AD7989_Driver
 {
 public: