[wpilib] Fix SmartDashboard.setDefault* docs (NFC) (wpilibsuite#6490)

Fix incorrect comments related to NT SetDefault* methods across multiple components
KangarooKoala · Dec 30, 2024 · eef1bf3 · eef1bf3
1 parent 78b6d61
commit eef1bf3
Show file tree

Hide file tree

Showing 7 changed files with 97 additions and 97 deletions.
diff --git a/ntcore/src/main/native/include/networktables/GenericEntry.h b/ntcore/src/main/native/include/networktables/GenericEntry.h
@@ -387,7 +387,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultBoolean(bool defaultValue) {
     return nt::SetDefaultBoolean(m_pubHandle, defaultValue);
@@ -397,7 +397,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultInteger(int64_t defaultValue) {
     return nt::SetDefaultInteger(m_pubHandle, defaultValue);
@@ -407,7 +407,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultFloat(float defaultValue) {
     return nt::SetDefaultFloat(m_pubHandle, defaultValue);
@@ -417,7 +417,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultDouble(double defaultValue) {
     return nt::SetDefaultDouble(m_pubHandle, defaultValue);
@@ -427,7 +427,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultString(std::string_view defaultValue) {
     return nt::SetDefaultString(m_pubHandle, defaultValue);
@@ -437,7 +437,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultRaw(std::span<const uint8_t> defaultValue) {
     return nt::SetDefaultRaw(m_pubHandle, defaultValue);
@@ -447,7 +447,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultBooleanArray(std::span<const int> defaultValue) {
     return nt::SetDefaultBooleanArray(m_pubHandle, defaultValue);
@@ -457,7 +457,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultIntegerArray(std::span<const int64_t> defaultValue) {
     return nt::SetDefaultIntegerArray(m_pubHandle, defaultValue);
@@ -467,7 +467,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultFloatArray(std::span<const float> defaultValue) {
     return nt::SetDefaultFloatArray(m_pubHandle, defaultValue);
@@ -477,7 +477,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultDoubleArray(std::span<const double> defaultValue) {
     return nt::SetDefaultDoubleArray(m_pubHandle, defaultValue);
@@ -487,7 +487,7 @@ class GenericPublisher : public Publisher {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultStringArray(std::span<const std::string> defaultValue) {
     return nt::SetDefaultStringArray(m_pubHandle, defaultValue);

diff --git a/ntcore/src/main/native/include/networktables/NetworkTable.h b/ntcore/src/main/native/include/networktables/NetworkTable.h
@@ -361,11 +361,11 @@ class NetworkTable final {
   bool PutNumber(std::string_view key, double value);
 
   /**
-   * Gets the current value in the table, setting it if it does not exist.
+   * Set Default Entry Value
    *
    * @param key the key
    * @param defaultValue the default value to set if key doesn't exist.
-   * @returns False if the table key exists with a different type
+   * @returns True if the table key did not already exist, otherwise False
    */
   bool SetDefaultNumber(std::string_view key, double defaultValue);
 
@@ -389,11 +389,11 @@ class NetworkTable final {
   bool PutString(std::string_view key, std::string_view value);
 
   /**
-   * Gets the current value in the table, setting it if it does not exist.
+   * Set Default Entry Value
    *
    * @param key the key
    * @param defaultValue the default value to set if key doesn't exist.
-   * @returns False if the table key exists with a different type
+   * @returns True if the table key did not already exist, otherwise False
    */
   bool SetDefaultString(std::string_view key, std::string_view defaultValue);
 
@@ -419,11 +419,11 @@ class NetworkTable final {
   bool PutBoolean(std::string_view key, bool value);
 
   /**
-   * Gets the current value in the table, setting it if it does not exist.
+   * Set Default Entry Value
    *
    * @param key the key
    * @param defaultValue the default value to set if key doesn't exist.
-   * @returns False if the table key exists with a different type
+   * @returns True if the table key did not already exist, otherwise False
    */
   bool SetDefaultBoolean(std::string_view key, bool defaultValue);
 
@@ -452,11 +452,11 @@ class NetworkTable final {
   bool PutBooleanArray(std::string_view key, std::span<const int> value);
 
   /**
-   * Gets the current value in the table, setting it if it does not exist.
+   * Set Default Entry Value
    *
    * @param key the key
    * @param defaultValue the default value to set if key doesn't exist.
-   * @return False if the table key exists with a different type
+   * @return True if the table key did not already exist, otherwise False
    */
   bool SetDefaultBooleanArray(std::string_view key,
                               std::span<const int> defaultValue);
@@ -490,11 +490,11 @@ class NetworkTable final {
   bool PutNumberArray(std::string_view key, std::span<const double> value);
 
   /**
-   * Gets the current value in the table, setting it if it does not exist.
+   * Set Default Entry Value
    *
    * @param key the key
    * @param defaultValue the default value to set if key doesn't exist.
-   * @returns False if the table key exists with a different type
+   * @returns True if the table key did not already exist, otherwise False
    */
   bool SetDefaultNumberArray(std::string_view key,
                              std::span<const double> defaultValue);
@@ -524,11 +524,11 @@ class NetworkTable final {
   bool PutStringArray(std::string_view key, std::span<const std::string> value);
 
   /**
-   * Gets the current value in the table, setting it if it does not exist.
+   * Set Default Entry Value
    *
    * @param key the key
    * @param defaultValue the default value to set if key doesn't exist.
-   * @returns False if the table key exists with a different type
+   * @returns True if the table key did not already exist, otherwise False
    */
   bool SetDefaultStringArray(std::string_view key,
                              std::span<const std::string> defaultValue);
@@ -558,11 +558,11 @@ class NetworkTable final {
   bool PutRaw(std::string_view key, std::span<const uint8_t> value);
 
   /**
-   * Gets the current value in the table, setting it if it does not exist.
+   * Set Default Entry Value
    *
    * @param key the key
    * @param defaultValue the default value to set if key doesn't exist.
-   * @return False if the table key exists with a different type
+   * @return True if the table key did not already exist, otherwise False
    */
   bool SetDefaultRaw(std::string_view key,
                      std::span<const uint8_t> defaultValue);
@@ -592,11 +592,11 @@ class NetworkTable final {
   bool PutValue(std::string_view key, const Value& value);
 
   /**
-   * Gets the current value in the table, setting it if it does not exist.
+   * Set Default Entry Value.
    *
    * @param key the key
    * @param defaultValue the default value to set if key doesn't exist.
-   * @return False if the table key exists with a different type
+   * @return True if the table key did not already exist, otherwise False
    */
   bool SetDefaultValue(std::string_view key, const Value& defaultValue);
 

diff --git a/ntcore/src/main/native/include/networktables/NetworkTableEntry.h b/ntcore/src/main/native/include/networktables/NetworkTableEntry.h
@@ -260,7 +260,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultValue(const Value& defaultValue) {
     return SetDefaultEntryValue(m_handle, defaultValue);
@@ -270,7 +270,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultBoolean(bool defaultValue) {
     return nt::SetDefaultBoolean(m_handle, defaultValue);
@@ -280,7 +280,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultInteger(int64_t defaultValue) {
     return nt::SetDefaultInteger(m_handle, defaultValue);
@@ -290,7 +290,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultFloat(float defaultValue) {
     return nt::SetDefaultFloat(m_handle, defaultValue);
@@ -300,7 +300,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultDouble(double defaultValue) {
     return nt::SetDefaultDouble(m_handle, defaultValue);
@@ -310,7 +310,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultString(std::string_view defaultValue) {
     return nt::SetDefaultString(m_handle, defaultValue);
@@ -320,7 +320,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultRaw(std::span<const uint8_t> defaultValue) {
     return nt::SetDefaultRaw(m_handle, defaultValue);
@@ -330,7 +330,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultBooleanArray(std::span<const int> defaultValue) {
     return nt::SetDefaultBooleanArray(m_handle, defaultValue);
@@ -340,7 +340,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultIntegerArray(std::span<const int64_t> defaultValue) {
     return nt::SetDefaultIntegerArray(m_handle, defaultValue);
@@ -350,7 +350,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultFloatArray(std::span<const float> defaultValue) {
     return nt::SetDefaultFloatArray(m_handle, defaultValue);
@@ -360,7 +360,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultDoubleArray(std::span<const double> defaultValue) {
     return nt::SetDefaultDoubleArray(m_handle, defaultValue);
@@ -370,7 +370,7 @@ class NetworkTableEntry final {
    * Sets the entry's value if it does not exist.
    *
    * @param defaultValue the default value to set
-   * @return False if the entry exists with a different type
+   * @return True if the entry did not already have a value, otherwise False
    */
   bool SetDefaultStringArray(std::span<const std::string> defaultValue) {
     return nt::SetDefaultStringArray(m_handle, defaultValue);

diff --git a/ntcore/src/main/native/include/ntcore_c.h b/ntcore/src/main/native/include/ntcore_c.h
@@ -476,8 +476,8 @@ void NT_GetEntryValueType(NT_Entry entry, unsigned int types,
 /**
  * Set Default Entry Value.
  *
- * Returns copy of current entry value if it exists.
- * Otherwise, sets passed in value, and returns set value.
+ * Returns 0 if name exists.
+ * Otherwise, sets passed in value, and returns 1.
  * Note that one of the type options is "unassigned".
  *
  * @param entry     entry handle

diff --git a/ntcore/src/main/native/include/ntcore_cpp.h b/ntcore/src/main/native/include/ntcore_cpp.h
@@ -488,8 +488,8 @@ Value GetEntryValue(NT_Handle subentry);
 /**
  * Set Default Entry Value
  *
- * Returns copy of current entry value if it exists.
- * Otherwise, sets passed in value, and returns set value.
+ * Returns False if name exists.
+ * Otherwise, sets passed in value, and returns True.
  * Note that one of the type options is "unassigned".
  *
  * @param entry     entry handle