Fix some dosctrings errors and trailing whitespaces

Signed-off-by: Kirill Luchikhin <kirill.luchikhin@intel.com>

src/buzzer/buzzer.h

@@ -49,7 +49,7 @@ class Buzzer {
         /**
          * Instanciates a Buzzer object
          *
-         * @param pin Buzzer pin number
+         * @param pinNumber Buzzer pin number
          */
         Buzzer (int pinNumber);
 

src/gy65/gy65.h

@@ -73,7 +73,8 @@ class GY65 {
          * Instanciates a GY65 object
          *
          * @param bus number of used bus
-         * @param devAddr addres of used i2c device
+         * @param devAddr address of used i2c device
+         * @param mode BMP085 mode
          */
         GY65 (int bus, int devAddr, uint8_t mode = BMP085_ULTRAHIGHRES);
 

src/hmc5883l/hmc5883l.h

@@ -29,19 +29,38 @@
 
 namespace upm {
 
+/**
+ * @brief C++ API for HMC5883l (3-axis digital compass)
+ *
+ * This file defines the HMC5883l C++ interface for libhmc5883l
+ *
+ * @snippet hmc5883l.cxx Interesting
+ *
+ */
+
 class Hmc5883l {
 public:
-    /// Creates a Hmc5883l object
+    /**
+     * Creates a Hmc5883l object
+     *
+     * @param bus number of used i2c bus
+     *
+     */
     Hmc5883l(int bus);
 
-    /// Returns the direction
+    /*
+     * Returns the direction
+     */
     float direction();
 
-    /// Returns the heading
+    /*
+     * Returns the heading
+     */
     float heading();
 
     /**
      * Returns a pointer to an int[3] that contains the coordinates as ints
+     *
      * @return *int to an int[3]
      */
     int* coordinates();

src/lcd/ssd1308.h

@@ -29,7 +29,7 @@
 
 namespace upm {
 
-#define DISPLAY_CMD_OFF                0xAE
+#define DISPLAY_CMD_OFF             0xAE
 #define DISPLAY_CMD_ON              0xAF
 
 #define BASE_LOW_COLUMN_ADDR        0x00

src/mic/mic.h

@@ -61,9 +61,9 @@ class Microphone {
          * Get samples from microphone according to provided window and
          * number of samples
          *
-         * @return freqMS time between each sample (in microseconds)
+         * @param freqMS time between each sample (in microseconds)
-         * @return numberOfSamples number of sample to sample for this window
+         * @param numberOfSamples number of sample to sample for this window
-         * @return buffer bufer with sampled data
+         * @param buffer bufer with sampled data
          */
         int getSampledWindow (unsigned int freqMS, unsigned int numberOfSamples, uint16_t * buffer);
 
@@ -71,12 +71,19 @@ class Microphone {
          * Given sampled buffer this method will return TRUE/FALSE if threshold
          * was reached
          *
-         * @return threshold sample threshold
+         * @param ctx threshold context
-         * @return buffer buffer with samples
+         * @param threshold sample threshold
-         * @return len bufer len
+         * @param buffer buffer with samples
+         * @param len bufer len
          */
         int findThreshold (thresholdContext* ctx, unsigned int threshold, uint16_t * buffer, unsigned int len);
 
+        /**
+         *
+         * Print running average of threshold context
+         *
+         * @param ctx threshold context
+         */
         void printGraph (thresholdContext* ctx);
 
     private:

src/mma7455/mma7455.cxx

@@ -173,4 +173,3 @@ MMA7455::ic2WriteReg (unsigned char reg, unsigned char * buf, unsigned char size
 
     return error;
 }
-

src/nrf24l01/nrf24l01.cxx

@@ -317,4 +317,3 @@ NRF24l01::nrfListenForChannel() {
         dataRecievedHandler(); /* let know that data arrived */
     }
 }
-

src/nrf24l01/nrf24l01.h

@@ -164,7 +164,7 @@ class NRF24l01 {
         /**
          * Send the buffer data
          *
-         * @param *value pointer to the buffer
+         * @param value pointer to the buffer
          */
         void nrfSend (uint8_t *value);
 
@@ -226,7 +226,7 @@ class NRF24l01 {
         /**
          * Sink all arrived data into the provided buffer
          *
-         * @param load size of the payload (MAX 32)
+         * @param data pointer to buffer of data
          */
         void nrfGetData (uint8_t * data);
 
@@ -238,7 +238,7 @@ class NRF24l01 {
         /**
          * Transmit provided data to the chip
          *
-         * @param *dataout pointer to the buffer with data
+         * @param dataout pointer to the buffer with data
          * @param len length of the buffer
          */
         void nrfTransmitSync (uint8_t *dataout, uint8_t len);
@@ -246,8 +246,8 @@ class NRF24l01 {
         /**
          * Recieve data from the chip
          *
-         * @param *dataout pointer to the buffer with data
+         * @param dataout pointer to the buffer with data
-         * @param *datain pointer to the buffer where the arrived data
+         * @param datain pointer to the buffer where the arrived data
          * will be sinked
          * @param len length of the buffer
          */
@@ -265,7 +265,7 @@ class NRF24l01 {
          * Read continues data from register
          *
          * @param reg register address
-         * @param *value pointer to the buffer
+         * @param value pointer to the buffer
          * @param len length of the buffer
          */
         void nrfReadRegister (uint8_t reg, uint8_t * value, uint8_t len);
@@ -274,7 +274,7 @@ class NRF24l01 {
          * Write continues data to register
          *
          * @param reg register address
-         * @param *value pointer to the buffer
+         * @param value pointer to the buffer
          * @param len length of the buffer
          */
         void nrfWriteRegister (uint8_t reg, uint8_t * value, uint8_t len);

src/st7735/gfx.h

@@ -163,8 +163,10 @@ class GFX {
         /**
          * Draw a circle
          *
-         * @param x center of circule on X scale
+         * @param x center of circle on X scale
-         * @param y center of circule on Y scale
+         * @param y center of circle on Y scale
+         * @param r radius of circle
+         * @param color color of circle
          */
         void drawCircle (int16_t x, int16_t y, int16_t r, uint16_t color);
 

src/st7735/st7735.h

@@ -552,7 +552,7 @@ class ST7735 : public GFX {
         /**
          * Execute set of commands and data
          *
-         * @param *addr pointer to start of the commands/data section
+         * @param addr pointer to start of the commands/data section
          */
         void executeCMDList (const uint8_t *addr);
 

src/tm1637/tm1637.h

@@ -87,7 +87,7 @@ class TM1637 {
         /**
          * Set the the segment screen data and number of segments
          *
-         * @param segments[] data to write on the segments, each elemnt
+         * @param segments data to write on the segments, each elemnt
          * in array is segment
          * @param length number of elements in segments array
          * @param pos data writing offset