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

@@ -21,9 +21,6 @@ using namespace frc;
PowerDistributionPanel::PowerDistributionPanel() : PowerDistributionPanel(0) {}
/**
* Initialize the PDP.
*/
PowerDistributionPanel::PowerDistributionPanel(int module) : m_module(module) {
int32_t status = 0;
HAL_InitializePDP(m_module, &status);
@@ -36,11 +33,6 @@ PowerDistributionPanel::PowerDistributionPanel(int module) : m_module(module) {
SetName("PowerDistributionPanel", module);
}
/**
* Query the input voltage of the PDP.
*
* @return The voltage of the PDP in volts
*/
double PowerDistributionPanel::GetVoltage() const {
int32_t status = 0;
@@ -53,11 +45,6 @@ double PowerDistributionPanel::GetVoltage() const {
return voltage;
}
/**
* Query the temperature of the PDP.
*
* @return The temperature of the PDP in degrees Celsius
*/
double PowerDistributionPanel::GetTemperature() const {
int32_t status = 0;
@@ -70,11 +57,6 @@ double PowerDistributionPanel::GetTemperature() const {
return temperature;
}
/**
* Query the current of a single channel of the PDP.
*
* @return The current of one of the PDP channels (channels 0-15) in Amperes
*/
double PowerDistributionPanel::GetCurrent(int channel) const {
int32_t status = 0;
@@ -94,11 +76,6 @@ double PowerDistributionPanel::GetCurrent(int channel) const {
return current;
}
/**
* Query the total current of all monitored PDP channels (0-15).
*
* @return The the total current drawn from the PDP channels in Amperes
*/
double PowerDistributionPanel::GetTotalCurrent() const {
int32_t status = 0;
@@ -111,11 +88,6 @@ double PowerDistributionPanel::GetTotalCurrent() const {
return current;
}
/**
* Query the total power drawn from the monitored PDP channels.
*
* @return The the total power drawn from the PDP channels in Watts
*/
double PowerDistributionPanel::GetTotalPower() const {
int32_t status = 0;
@@ -128,11 +100,6 @@ double PowerDistributionPanel::GetTotalPower() const {
return power;
}
/**
* Query the total energy drawn from the monitored PDP channels.
*
* @return The the total energy drawn from the PDP channels in Joules
*/
double PowerDistributionPanel::GetTotalEnergy() const {
int32_t status = 0;
@@ -145,11 +112,6 @@ double PowerDistributionPanel::GetTotalEnergy() const {
return energy;
}
/**
* Reset the total energy drawn from the PDP.
*
* @see PowerDistributionPanel#GetTotalEnergy
*/
void PowerDistributionPanel::ResetTotalEnergy() {
int32_t status = 0;
@@ -160,9 +122,6 @@ void PowerDistributionPanel::ResetTotalEnergy() {
}
}
/**
* Remove all of the fault flags on the PDP.
*/
void PowerDistributionPanel::ClearStickyFaults() {
int32_t status = 0;