Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-03 03:01:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Fix wpilibj JavaDoc warnings (#6154)

Browse Source
This commit is contained in:
Tyler Veness
2024-01-05 07:35:59 -08:00
committed by GitHub
parent 19cb2a8eb4
commit 106518c3f8
97 changed files with 1112 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
hal/src/main/native/include/hal/DMA.h
View File

@@ -138,6 +138,8 @@ void HAL_AddDMACounter(HAL_DMAHandle handle, HAL_CounterHandle counterHandle,
/**
* Adds timer data for an counter to be collected by DMA.
*
* This can only be called if DMA is not started.
*
* @param[in] handle the dma handle
* @param[in] counterHandle the counter to add
* @param[out] status Error status variable. 0 on success.

9
hal/src/main/native/include/hal/PowerDistribution.h
View File

@@ -217,12 +217,21 @@ void HAL_SetPowerDistributionSwitchableChannel(
HAL_Bool HAL_GetPowerDistributionSwitchableChannel(
HAL_PowerDistributionHandle handle, int32_t* status);
/**
* Power distribution version.
*/
struct HAL_PowerDistributionVersion {
/// Firmware major version number.
uint32_t firmwareMajor;
/// Firmware minor version number.
uint32_t firmwareMinor;
/// Firmware fix version number.
uint32_t firmwareFix;
/// Hardware minor version number.
uint32_t hardwareMinor;
/// Hardware major version number.
uint32_t hardwareMajor;
/// Unique ID.
uint32_t uniqueId;
};