Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-01 02:41:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up misc documentation

Browse Source 
Change-Id: Ib0a4a7a389fb657d78d8b8bce4fcaeed67c3693d
This commit is contained in:
Joe Ross
2014-12-29 15:10:41 -08:00
parent 2d15b6b03e
commit d165f57e6e
5 changed files with 12 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
wpilibc/wpilibC++Devices/src/Gyro.cpp
View File

@@ -71,9 +71,10 @@ void Gyro::InitGyro()
}
/**
* Gyro constructor using the channel number.
* Gyro constructor using the Analog Input channel number.
*
* @param channel The analog channel the gyro is connected to. 0-3 are on-board, 4-7 are on the MXP.
* @param channel The analog channel the gyro is connected to. Gyros
can only be used on on-board Analog Inputs 0-1.
*/
Gyro::Gyro(int32_t channel)
{
@@ -85,7 +86,8 @@ Gyro::Gyro(int32_t channel)
/**
* Gyro constructor with a precreated AnalogInput object.
* Use this constructor when the analog channel needs to be shared.
* This object will not clean up the AnalogInput object when using this constructor
* This object will not clean up the AnalogInput object when using this constructor.
* Gyros can only be used on on-board channels 0-1.
* @param channel A pointer to the AnalogInput object that the gyro is connected to.
*/
Gyro::Gyro(AnalogInput *channel)