Moved C++ comments from source files to headers (#1111)

Also sorted functions in C++ sources to match order in related headers.
This commit is contained in:
Tyler Veness
2018-05-31 20:47:15 -07:00
committed by Peter Johnson
parent d9971a705a
commit 8c680a26f8
234 changed files with 9936 additions and 9309 deletions

View File

@@ -22,12 +22,36 @@ class BuiltInAccelerometer : public ErrorBase,
public SendableBase,
public Accelerometer {
public:
/**
* Constructor.
*
* @param range The range the accelerometer will measure
*/
explicit BuiltInAccelerometer(Range range = kRange_8G);
// Accelerometer interface
/**
* Set the measuring range of the accelerometer.
*
* @param range The maximum acceleration, positive or negative, that the
* accelerometer will measure. Not all accelerometers support all
* ranges.
*/
void SetRange(Range range) override;
/**
* @return The acceleration of the roboRIO along the X axis in g-forces
*/
double GetX() override;
/**
* @return The acceleration of the roboRIO along the Y axis in g-forces
*/
double GetY() override;
/**
* @return The acceleration of the roboRIO along the Z axis in g-forces
*/
double GetZ() override;
void InitSendable(SendableBuilder& builder) override;