mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-07-02 02:51:42 +00:00
Removed {@inheritDoc} from C++ sources and readded .inc files to Doxygen extension mapping
{@inheritDoc} doesn't exist in Doxygen, so I removed instances of it from the C++ source. It isn't needed anyway because Doxygen automatically fills in base class documentation for member functions in derived classes if no documentation is given. The extension mapping for .inc files was accidentally removed during the build system changes so this commit adds it back in.
Change-Id: I599e3bdafd76ee7d78a66090d81707cda5a399d7
This commit is contained in:
@@ -34,18 +34,14 @@ ADXL345_I2C::ADXL345_I2C(Port port, Range range, int deviceAddress) : I2C(port,
|
||||
LiveWindow::GetInstance()->AddSensor("ADXL345_I2C", port, this);
|
||||
}
|
||||
|
||||
/** {@inheritdoc} */
|
||||
void ADXL345_I2C::SetRange(Range range) {
|
||||
Write(kDataFormatRegister, kDataFormat_FullRes | (uint8_t)range);
|
||||
}
|
||||
|
||||
/** {@inheritdoc} */
|
||||
double ADXL345_I2C::GetX() { return GetAcceleration(kAxis_X); }
|
||||
|
||||
/** {@inheritdoc} */
|
||||
double ADXL345_I2C::GetY() { return GetAcceleration(kAxis_Y); }
|
||||
|
||||
/** {@inheritdoc} */
|
||||
double ADXL345_I2C::GetZ() { return GetAcceleration(kAxis_Z); }
|
||||
|
||||
/**
|
||||
|
||||
@@ -42,7 +42,6 @@ ADXL345_SPI::ADXL345_SPI(SPI::Port port, ADXL345_SPI::Range range) : SPI(port) {
|
||||
LiveWindow::GetInstance()->AddSensor("ADXL345_SPI", port, this);
|
||||
}
|
||||
|
||||
/** {@inheritdoc} */
|
||||
void ADXL345_SPI::SetRange(Range range) {
|
||||
uint8_t commands[2];
|
||||
|
||||
@@ -52,13 +51,10 @@ void ADXL345_SPI::SetRange(Range range) {
|
||||
Transaction(commands, commands, 2);
|
||||
}
|
||||
|
||||
/** {@inheritdoc} */
|
||||
double ADXL345_SPI::GetX() { return GetAcceleration(kAxis_X); }
|
||||
|
||||
/** {@inheritdoc} */
|
||||
double ADXL345_SPI::GetY() { return GetAcceleration(kAxis_Y); }
|
||||
|
||||
/** {@inheritdoc} */
|
||||
double ADXL345_SPI::GetZ() { return GetAcceleration(kAxis_Z); }
|
||||
|
||||
/**
|
||||
|
||||
@@ -73,7 +73,6 @@ ADXL362::ADXL362(SPI::Port port, Range range) : m_spi(port) {
|
||||
LiveWindow::GetInstance()->AddSensor("ADXL362", port, this);
|
||||
}
|
||||
|
||||
/** {@inheritdoc} */
|
||||
void ADXL362::SetRange(Range range) {
|
||||
if (m_gsPerLSB == 0.0) return;
|
||||
|
||||
@@ -99,13 +98,10 @@ void ADXL362::SetRange(Range range) {
|
||||
m_spi.Write(commands, 3);
|
||||
}
|
||||
|
||||
/** {@inheritdoc} */
|
||||
double ADXL362::GetX() { return GetAcceleration(kAxis_X); }
|
||||
|
||||
/** {@inheritdoc} */
|
||||
double ADXL362::GetY() { return GetAcceleration(kAxis_Y); }
|
||||
|
||||
/** {@inheritdoc} */
|
||||
double ADXL362::GetZ() { return GetAcceleration(kAxis_Z); }
|
||||
|
||||
/**
|
||||
|
||||
@@ -135,9 +135,6 @@ void AnalogGyro::InitGyro() {
|
||||
LiveWindow::GetInstance()->AddSensor("AnalogGyro", m_analog->GetChannel(), this);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
void AnalogGyro::Calibrate() {
|
||||
if (StatusIsFatal()) return;
|
||||
|
||||
|
||||
@@ -22,7 +22,6 @@ BuiltInAccelerometer::BuiltInAccelerometer(Range range) {
|
||||
LiveWindow::GetInstance()->AddSensor((std::string) "BuiltInAccel", 0, this);
|
||||
}
|
||||
|
||||
/** {@inheritdoc} */
|
||||
void BuiltInAccelerometer::SetRange(Range range) {
|
||||
if (range == kRange_16G) {
|
||||
wpi_setWPIErrorWithContext(
|
||||
|
||||
@@ -130,6 +130,7 @@ if (checkDoxygen()) {
|
||||
source file("$halLocation/include")
|
||||
// template file('cpp.doxy')
|
||||
exclude 'nivision.h'
|
||||
extension_mapping 'inc=C++'
|
||||
project_name 'WPILibC++'
|
||||
javadoc_autobrief true
|
||||
recursive true
|
||||
|
||||
@@ -115,9 +115,6 @@ LinearDigitalFilter LinearDigitalFilter::MovingAverage(std::shared_ptr<PIDSource
|
||||
return LinearDigitalFilter(std::move(source), gains, {});
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
double LinearDigitalFilter::Get() const {
|
||||
double retVal = 0.0;
|
||||
|
||||
@@ -132,9 +129,6 @@ double LinearDigitalFilter::Get() const {
|
||||
return retVal;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
void LinearDigitalFilter::Reset() {
|
||||
m_inputs.Reset();
|
||||
m_outputs.Reset();
|
||||
|
||||
Reference in New Issue
Block a user