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

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

View File

@@ -15,6 +15,7 @@ PowerDistributionPanel::PowerDistributionPanel() {
}
/**
* Query the input voltage of the PDP
* @return The voltage of the PDP
*/
double
@@ -31,6 +32,7 @@ PowerDistributionPanel::GetVoltage() {
}
/**
* Query the temperature of the PDP
* @return The temperature of the PDP in degrees Celsius
*/
double
@@ -47,6 +49,7 @@ PowerDistributionPanel::GetTemperature() {
}
/**
* 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
@@ -70,6 +73,7 @@ PowerDistributionPanel::GetCurrent(uint8_t channel) {
}
/**
* Query the total current of all monitored PDP channels (0-15)
* @return The the total current drawn from the PDP channels in Amperes
*/
double
@@ -86,6 +90,7 @@ PowerDistributionPanel::GetTotalCurrent() {
}
/**
* Query the total power drawn from the monitored PDP channels
* @return The the total power drawn from the PDP channels in Joules
*/
double
@@ -102,6 +107,7 @@ PowerDistributionPanel::GetTotalPower() {
}
/**
* Query the total energy drawn from the monitored PDP channels
* @return The the total energy drawn from the PDP channels in Watts
*/
double