Diff: TransmitterIR.h

Revision:

8:46e34d6ddbe4

Parent:

2:08836610bd4a

Child:

9:dcfdac59ef74

--- a/TransmitterIR.h	Sat Aug 21 11:05:57 2010 +0000
+++ b/TransmitterIR.h	Sat Aug 21 13:28:50 2010 +0000
@@ -13,9 +13,22 @@
 #include "Semaphore.h"
 #include "RemoteIR.h"
 
+/**
+ * IR transmitter class.
+ */
 class TransmitterIR {
 public:
+
+    /**
+     * Constructor.
+     *
+     * @param txpin Pin for transmit IR signal.
+     */
     explicit TransmitterIR(PinName txpin);
+
+    /**
+     * Destructor.
+     */
     ~TransmitterIR();
 
     typedef enum {
@@ -25,7 +38,22 @@
         Trailer
     } State;
 
+    /**
+     * Get state.
+     *
+     * @return Current state.
+     */
     State getState(void);
+
+    /**
+     * Set data.
+     *
+     * @param format Format.
+     * @param buf Buffer of a data.
+     * @param bitlength Bit length of the data.
+     *
+     * @return Data bit length.
+     */
     int setData(RemoteIR::Format format, uint8_t *buf, int bitlength);
 
 private: