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

Update docs for C++ (fixes artf3761 and artf3953)

Browse Source 
Change-Id: Ic0c4ac8494cadff13461d9bb8b5943cd87619f0a
This commit is contained in:
Kevin O'Connor
2014-12-29 14:09:37 -05:00
parent a6aef54ef4
commit 6d8e782f53
39 changed files with 342 additions and 164 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
wpilibc/wpilibC++Devices/src/AnalogAccelerometer.cpp
View File

@@ -23,8 +23,8 @@ void AnalogAccelerometer::InitAccelerometer()
/**
* Create a new instance of an accelerometer.
*
* The constructor allocates desired analog input.
* @param channel The channel number for the analog input the accelerometer is connected to
*/
AnalogAccelerometer::AnalogAccelerometer(int32_t channel)
{
@@ -38,6 +38,7 @@ AnalogAccelerometer::AnalogAccelerometer(int32_t channel)
* Make a new instance of accelerometer given an AnalogInput. This is particularly
* useful if the port is going to be read as an analog channel as well as through
* the Accelerometer class.
* @param channel The existing AnalogInput object for the analog input the accelerometer is connected to
*/
AnalogAccelerometer::AnalogAccelerometer(AnalogInput *channel)
{
@@ -80,7 +81,7 @@ float AnalogAccelerometer::GetAcceleration()
* Set the accelerometer sensitivity.
*
* This sets the sensitivity of the accelerometer used for calculating the acceleration.
* The sensitivity varys by accelerometer model. There are constants defined for various models.
* The sensitivity varies by accelerometer model. There are constants defined for various models.
*
* @param sensitivity The sensitivity of accelerometer in Volts per G.
*/
@@ -92,7 +93,7 @@ void AnalogAccelerometer::SetSensitivity(float sensitivity)
/**
* Set the voltage that corresponds to 0 G.
*
* The zero G voltage varys by accelerometer model. There are constants defined for various models.
* The zero G voltage varies by accelerometer model. There are constants defined for various models.
*
* @param zero The zero G voltage.
*/