Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-24 01:31:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[hal] Miscellaneous HAL doc fixes (NFC) (#5306)

Browse Source
This commit is contained in:
sciencewhiz
2023-05-07 22:55:48 -07:00
committed by GitHub
parent 7ce75574bf
commit 1dff81bea7
3 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
hal/src/main/native/include/hal/AnalogInput.h
View File

@@ -162,9 +162,9 @@ int32_t HAL_GetAnalogValue(HAL_AnalogInputHandle analogPortHandle,
* The sample is 12-bit + the value configured in SetOversampleBits().
* The value configured in SetAverageBits() will cause this value to be averaged
* 2**bits number of samples. This is not a sliding window. The sample will not
* change until 2**(OversamplBits + AverageBits) samples have been acquired from
* the module on this channel. Use GetAverageVoltage() to get the analog value
* in calibrated units.
* change until 2**(OversampleBits + AverageBits) samples have been acquired
* from the module on this channel. Use GetAverageVoltage() to get the analog
* value in calibrated units.
*
* @param[in] analogPortHandle Handle to the analog port to use.
* @param[out] status the error code, or 0 for success

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

@@ -241,7 +241,7 @@ void HAL_SetFilterPeriod(int32_t filterIndex, int64_t value, int32_t* status);
*
* Gets the filter period in FPGA cycles. Even though there are 2 different
* filter index domains (MXP vs HDR), ignore that distinction for now since it
* compilicates the interface. Set status to NiFpga_Status_SoftwareFault if the
* complicates the interface. Set status to NiFpga_Status_SoftwareFault if the
* filter values miss-match.
*
* @param[in] filterIndex the filter index, 0 - 2

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

@@ -17,7 +17,7 @@
// clang-format off
/**
* The acceptable accelerometer ranges.
* The types of power distribution devices.
*/
HAL_ENUM(HAL_PowerDistributionType) {
HAL_PowerDistributionType_kAutomatic = 0,
@@ -39,7 +39,7 @@ extern "C" {
* @param[in] type the type of module to initialize
* @param[in] allocationLocation the location where the allocation is occurring
* @param[out] status Error status variable. 0 on success.
* @return the created PowerDistribution
* @return the created PowerDistribution handle
*/
HAL_PowerDistributionHandle HAL_InitializePowerDistribution(
int32_t moduleNumber, HAL_PowerDistributionType type,