Fix doxygen warnings in 'drivers'

drivers/CAN.h

@@ -46,6 +46,12 @@ public:
     }
 
     /** Creates CAN message with specific content.
+     *
+     *  @param _id      Message ID
+     *  @param _data    Mesaage Data
+     *  @param _len     Message Data length
+     *  @param _type    Type of Data: Use enum CANType for valid parameter values
+     *  @param _format  Data Format: Use enum CANFormat for valid parameter values
      */
     CANMessage(int _id, const char *_data, char _len = 8, CANType _type = CANData, CANFormat _format = CANStandard) {
       len    = _len & 0xF;
@@ -56,6 +62,9 @@ public:
     }
 
     /** Creates CAN remote message.
+     *
+     *  @param _id      Message ID
+     *  @param _format  Data Format: Use enum CANType for valid parameter values
      */
     CANMessage(int _id, CANFormat _format = CANStandard) {
       len    = 0;
@@ -197,11 +206,15 @@ public:
      */
     int filter(unsigned int id, unsigned int mask, CANFormat format = CANAny, int handle = 0);
 
-    /** Returns number of read errors to detect read overflow errors.
+    /**  Detects read errors - Used to detect read overflow errors.
+     *
+     *  @returns number of read errors
      */
     unsigned char rderror();
 
-    /** Returns number of write errors to detect write overflow errors.
+    /** Detects write errors - Used to detect write overflow errors.
+     *
+     *  @returns number of write errors
      */
     unsigned char tderror();
 

drivers/Ethernet.h

@@ -111,15 +111,16 @@ public:
 
     /** Read from an recevied ethernet packet.
      *
-     *  After receive returnd a number bigger than 0it is
+     *  After receive returned a number bigger than 0 it is
      *  possible to read bytes from this packet.
-     *  Read will write up to size bytes into data.
      *
-     *  It is possible to use read multible times.
+     *  @param data      Pointer to data packet
+     *  @param size      Size of data to be read.
+     *  @returns         The number of byte read.
+     *
+     *  @note It is possible to use read multiple times.
      *  Each time read will start reading after the last read byte before.
      *
-     *  @returns
-     *  The number of byte read.
      */
     int read(char *data, int size);
 

drivers/InterruptManager.h

@@ -55,7 +55,9 @@ namespace mbed {
  */
 class InterruptManager {
 public:
-    /** Return the only instance of this class
+    /** Get the instance of InterruptManager Class
+     *
+     *  @return the only instance of this class
      */
     static InterruptManager* get();
 

drivers/Timer.h

@@ -67,14 +67,20 @@ public:
     void reset();
 
     /** Get the time passed in seconds
+     *
+     *  @returns    Time passed in seconds
      */
     float read();
 
-    /** Get the time passed in mili-seconds
+    /** Get the time passed in milli-seconds
+     *
+     *  @returns    Time passed in milli seconds
      */
     int read_ms();
 
     /** Get the time passed in micro-seconds
+     *
+     *  @returns    Time passed in micro seconds
      */
     int read_us();
 

drivers/TimerEvent.h

@@ -33,6 +33,8 @@ public:
     TimerEvent(const ticker_data_t *data);
 
     /** The handler registered with the underlying timer interrupt
+     *
+     *  @param id       Timer Event ID
      */
     static void irq(uint32_t id);
 

hal/can_helper.h

@@ -25,6 +25,12 @@
 extern "C" {
 #endif
 
+/**
+ *
+ * \enum    CANFormat
+ *
+ * \brief   Values that represent CAN Format
+**/
 enum CANFormat {
     CANStandard = 0,
     CANExtended = 1,
@@ -32,18 +38,31 @@ enum CANFormat {
 };
 typedef enum CANFormat CANFormat;
 
+/**
+ *
+ * \enum    CANType
+ *
+ * \brief   Values that represent CAN Type
+**/
 enum CANType {
     CANData   = 0,
     CANRemote = 1
 };
 typedef enum CANType CANType;
 
+/**
+ *
+ * \struct  CAN_Message
+ *
+ * \brief   Holder for single CAN message.
+ *
+**/
 struct CAN_Message {
     unsigned int   id;                 // 29 bit identifier
     unsigned char  data[8];            // Data field
     unsigned char  len;                // Length of data field in bytes
-    CANFormat      format;             // 0 - STANDARD, 1- EXTENDED IDENTIFIER
+    CANFormat      format;             // Format ::CANFormat
-    CANType        type;               // 0 - DATA FRAME, 1 - REMOTE FRAME
+    CANType        type;               // Type ::CANType
 };
 typedef struct CAN_Message CAN_Message;