docs: updated @param tags, added missing function descriptions, other minor changes

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2017-04-10 16:59:39 -07:00
parent 39df7fd10f
commit 3aef2ea70e
94 changed files with 327 additions and 222 deletions

View File

@ -154,7 +154,8 @@ class SmartDrive {
public:
/**
* Initialize the class with the i2c address of your SmartDrive
* @param SmartDrive_address Address of your SmartDrive.
* @param i2c_bus I2C bus to use.
* @param address Address of your SmartDrive.
*/
SmartDrive(int i2c_bus, int address = SmartDrive_DefaultAddress);
@ -238,7 +239,6 @@ public:
/**
* Turns the specified motor(s) for given absolute tacheometer count
* @param motor_id Number of the motor(s) you wish to turn.
* @param direction The direction you wish to turn the motor(s).
* @param speed The speed at which you wish to turn the motor(s).
* @param tacho_count The absolute tacheometer count you wish to turn the motor(s).
* @param wait_for_completion Tells the program when to handle the next line of code.