docs: more header files edited

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions

View File

@ -45,7 +45,7 @@ namespace upm {
*
* @brief API for the Grove Electromagnet
*
* The Grove Electromagnet can hold up to 1 KG (approximately 2.2 lbs)
* The Grove Electromagnet can hold up to 1 kg (approximately 2.2 lbs)
*
* @image html groveelectromagnet.jpg
* @snippet groveelectromagnet.cxx Interesting
@ -53,21 +53,21 @@ namespace upm {
class GroveElectromagnet {
public:
/**
* Grove Electromagnet Constructor
* Grove Electromagnet constructor
*
* @param pin digital pin to use
* @param pin Digital pin to use
*/
GroveElectromagnet(int pin);
/**
* Grove Electromagnet Destructor
* Grove Electromagnet destructor
*/
~GroveElectromagnet();
/**
* Turn magnet on
* Turns the magnet on
*/
void on();
/**
* Turn magnet off
* Turns the magnet off
*/
void off();