From 663bf25aafd92a8fd9e23dd90b96852c1ea2df64 Mon Sep 17 00:00:00 2001
From: Ryan Blue <ryanzblue@gmail.com>
Date: Thu, 22 Jun 2023 23:58:38 -0400
Subject: [PATCH] [docs] Generate docs for symbols in __cplusplus (#5412)

---
 docs/build.gradle                                    |  4 +++-
 hal/src/main/native/include/hal/SimDevice.h          | 12 ++++++------
 .../src/main/native/include/wpi/Synchronization.h    |  3 +--
 3 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/docs/build.gradle b/docs/build.gradle
index e9056a81a4..460646ee6c 100644
--- a/docs/build.gradle
+++ b/docs/build.gradle
@@ -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'
diff --git a/hal/src/main/native/include/hal/SimDevice.h b/hal/src/main/native/include/hal/SimDevice.h
index d20e1e6454..0e75cea5f5 100644
--- a/hal/src/main/native/include/hal/SimDevice.h
+++ b/hal/src/main/native/include/hal/SimDevice.h
@@ -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) {}
diff --git a/wpiutil/src/main/native/include/wpi/Synchronization.h b/wpiutil/src/main/native/include/wpi/Synchronization.h
index 4ac3c8c811..62a79efd98 100644
--- a/wpiutil/src/main/native/include/wpi/Synchronization.h
+++ b/wpiutil/src/main/native/include/wpi/Synchronization.h
@@ -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);