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

[docs] Generate docs for symbols in __cplusplus (#5412)

Browse Source
This commit is contained in:
Ryan Blue
2023-06-22 23:58:38 -04:00
committed by GitHub
parent fe32127ea8
commit 663bf25aaf
3 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/build.gradle
View File

@@ -172,7 +172,9 @@ doxygen {
enable_preprocessing true
macro_expansion true
expand_only_predef true
predefined "WPI_DEPRECATED(x)=[[deprecated(x)]]"
predefined "WPI_DEPRECATED(x)=[[deprecated(x)]]\"\\\n" +
"\"__cplusplus"
if (project.hasProperty('docWarningsAsErrors')) {
warn_as_error 'FAIL_ON_WARNINGS'

12
hal/src/main/native/include/hal/SimDevice.h
View File

@@ -409,7 +409,7 @@ class SimValue {
/**
* Wraps a simulated value handle as returned by HAL_CreateSimValue().
*
* @param handle simulated value handle
* @param val simulated value handle
*/
/*implicit*/ SimValue(HAL_SimValueHandle val) // NOLINT
: m_handle(val) {}
@@ -461,7 +461,7 @@ class SimInt : public SimValue {
/**
* Wraps a simulated value handle as returned by HAL_CreateSimValueInt().
*
* @param handle simulated value handle
* @param val simulated value handle
*/
/*implicit*/ SimInt(HAL_SimValueHandle val) // NOLINT
: SimValue(val) {}
@@ -502,7 +502,7 @@ class SimLong : public SimValue {
/**
* Wraps a simulated value handle as returned by HAL_CreateSimValueLong().
*
* @param handle simulated value handle
* @param val simulated value handle
*/
/*implicit*/ SimLong(HAL_SimValueHandle val) // NOLINT
: SimValue(val) {}
@@ -543,7 +543,7 @@ class SimDouble : public SimValue {
/**
* Wraps a simulated value handle as returned by HAL_CreateSimValueDouble().
*
* @param handle simulated value handle
* @param val simulated value handle
*/
/*implicit*/ SimDouble(HAL_SimValueHandle val) // NOLINT
: SimValue(val) {}
@@ -584,7 +584,7 @@ class SimEnum : public SimValue {
/**
* Wraps a simulated value handle as returned by HAL_CreateSimValueEnum().
*
* @param handle simulated value handle
* @param val simulated value handle
*/
/*implicit*/ SimEnum(HAL_SimValueHandle val) // NOLINT
: SimValue(val) {}
@@ -618,7 +618,7 @@ class SimBoolean : public SimValue {
/**
* Wraps a simulated value handle as returned by HAL_CreateSimValueBoolean().
*
* @param handle simulated value handle
* @param val simulated value handle
*/
/*implicit*/ SimBoolean(HAL_SimValueHandle val) // NOLINT
: SimValue(val) {}

3
wpiutil/src/main/native/include/wpi/Synchronization.h
View File

@@ -209,10 +209,9 @@ inline std::span<WPI_Handle> WaitForObjects(
* Sets up signaling for an arbitrary handle. With this function, any handle
* can operate like an event handle.
*
* @param handle handle
* @param handle Event handle
* @param manualReset true for manual reset, false for automatic reset
* @param initialState true to make the handle initially in signaled state
* @return Event handle
*/
void CreateSignalObject(WPI_Handle handle, bool manualReset = false,
bool initialState = false);