[wpilib] Improve PDP comments (NFC) (#3427)

Also remove HAL doxygen comments from sources;
these functions already had more descriptive comments in their
corresponding headers.
This commit is contained in:
Tyler Veness
2021-06-10 00:02:51 -07:00
committed by GitHub
parent f8fc2463ee
commit 099fde97d5
4 changed files with 17 additions and 13 deletions

View File

@@ -18,9 +18,6 @@ using namespace frc;
PowerDistributionPanel::PowerDistributionPanel() : PowerDistributionPanel(0) {}
/**
* Initialize the PDP.
*/
PowerDistributionPanel::PowerDistributionPanel(int module) : m_module(module) {
int32_t status = 0;
m_handle = HAL_InitializePDP(module, &status);

View File

@@ -20,7 +20,18 @@ class SendableBuilder;
class PowerDistributionPanel : public Sendable,
public SendableHelper<PowerDistributionPanel> {
public:
/**
* Constructs a PowerDistributionPanel.
*
* Uses the default CAN ID (0).
*/
PowerDistributionPanel();
/**
* Constructs a PowerDistributionPanel.
*
* @param module The CAN ID of the PDP
*/
explicit PowerDistributionPanel(int module);
PowerDistributionPanel(PowerDistributionPanel&&) = default;