Diff: RWDModule.h

Revision:

4:0c21bc193afa

Parent:

2:37fafd1e1a20

diff -r 60db4ab4dafe -r 0c21bc193afa RWDModule.h
--- a/RWDModule.h	Wed Jul 14 10:45:29 2010 +0000
+++ b/RWDModule.h	Thu Jul 22 16:24:31 2010 +0000
@@ -26,39 +26,43 @@
 
 #include "mbed.h"
 
-/*
+//!Generic driver for the RWD RFID Modules from IB Technology.
+/*!
 The RWD modules from IB Technology are RFID readers working with different frequencies and protocols but with a common instructions set and pinout.
 */
 class RWDModule
 {
 public:
-  /*
+  //!Creates an instance of the class.
+  /*!
   Connect module using serial port pins tx, rx and DigitalIn pin cts (clear-to-send).
   */
   RWDModule(PinName tx, PinName rx, PinName cts);
   
-  /*
+  /*!
   Destroys instance.
   */
   virtual ~RWDModule();
   
-
-  /*
+  //!Executes a command.
+  /*!
   Executes the command cmd on the reader, with parameters set in params buffer of paramsLen length. The acknowledge byte sent back by the reader masked with ackOkMask  must be equal to ackOk for the command to be considered a success. If so, the result is stored in buffer resp of length respLen.
   This is a non-blocking function, and ready() should be called to check completion.
   Please note that the buffers references must remain valid until the command has been executed.
   */
   void command(uint8_t cmd, const uint8_t* params, int paramsLen, uint8_t* resp, size_t respLen, uint8_t ackOk, size_t ackOkMask); //Ack Byte is not included in the resp buf
   
-  /*
+  //!Ready for a command / response is available.
+  /*!
   Returns true if the previous command has been executed and an other command is ready to be sent.
   */
-  bool ready(); //Ready for a command / response is available
+  bool ready();
   
-  /*
+  //!Get whether last command was succesful, and complete ack byte if a ptr is provided.
+  /*!
   Returns true if the previous command was successful. If pAck is provided, the actual acknowledge byte returned by the reader is stored in that variable.
   */
-  bool result(uint8_t* pAck = NULL); //Get wether last command was succesful, and complete ack byte if a ptr is provided
+  bool result(uint8_t* pAck = NULL);
 
 private:
   void intClearToSend(); //Called on interrupt when CTS line falls