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

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

Browse Source 
Fix incorrect comments related to NT SetDefault* methods across multiple components
This commit is contained in:
Carl Hauser
2024-12-29 16:41:29 -08:00
committed by GitHub
parent 78b6d61e88
commit eef1bf33de
7 changed files with 97 additions and 97 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
wpilibc/src/main/native/include/frc/smartdashboard/SmartDashboard.h
View File

@@ -122,10 +122,10 @@ class SmartDashboard {
static bool PutBoolean(std::string_view keyName, bool value);
/**
* Gets the current value in the table, setting it if it does not exist.
* Set the value in the table if key does not exist
* @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
* @param defaultValue the value to set if key doesn't exist.
* @returns True if the table key did not already exist, otherwise False
*/
static bool SetDefaultBoolean(std::string_view key, bool defaultValue);
@@ -135,7 +135,7 @@ class SmartDashboard {
* If the key is not found, returns the default value.
*
* @param keyName the key
* @param defaultValue the default value to set if key doesn't exist
* @param defaultValue the default value to return if key doesn't exist
* @return the value
*/
static bool GetBoolean(std::string_view keyName, bool defaultValue);
@@ -153,11 +153,11 @@ class SmartDashboard {
static bool PutNumber(std::string_view keyName, double value);
/**
* Gets the current value in the table, setting it if it does not exist.
* Set the value in the table if key does not exist.
*
* @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
* @param defaultValue The value to set if key doesn't exist.
* @returns True if the table key did not already exist, otherwise False
*/
static bool SetDefaultNumber(std::string_view key, double defaultValue);
@@ -167,7 +167,7 @@ class SmartDashboard {
* If the key is not found, returns the default value.
*
* @param keyName the key
* @param defaultValue the default value to set if the key doesn't exist
* @param defaultValue the default value to return if the key doesn't exist
* @return the value
*/
static double GetNumber(std::string_view keyName, double defaultValue);
@@ -185,11 +185,11 @@ class SmartDashboard {
static bool PutString(std::string_view keyName, std::string_view value);
/**
* Gets the current value in the table, setting it if it does not exist.
* Set the value in the table if key does not exist.
*
* @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
* @param defaultValue the value to set if key doesn't exist.
* @returns True if the table key did not already exist, otherwise False
*/
static bool SetDefaultString(std::string_view key,
std::string_view defaultValue);
@@ -200,7 +200,7 @@ class SmartDashboard {
* If the key is not found, returns the default value.
*
* @param keyName the key
* @param defaultValue the default value to set if the key doesn't exist
* @param defaultValue the default value to return if the key doesn't exist
* @return the value
*/
static std::string GetString(std::string_view keyName,
@@ -220,11 +220,11 @@ class SmartDashboard {
static 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 the value in the table if key does not exist.
*
* @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
* @param defaultValue the value to set if key doesn't exist.
* @returns True if the table key did not already exist, otherwise False
*/
static bool SetDefaultBooleanArray(std::string_view key,
std::span<const int> defaultValue);
@@ -261,11 +261,11 @@ class SmartDashboard {
std::span<const double> value);
/**
* Gets the current value in the table, setting it if it does not exist.
* Set the value in the table if key does not exist.
*
* @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
* @param defaultValue The value to set if key doesn't exist.
* @returns True if the table key did not already exist, otherwise False
*/
static bool SetDefaultNumberArray(std::string_view key,
std::span<const double> defaultValue);
@@ -298,11 +298,11 @@ class SmartDashboard {
std::span<const std::string> value);
/**
* Gets the current value in the table, setting it if it does not exist.
* Set the value in the table if key does not exist.
*
* @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
* @param defaultValue The value to set if key doesn't exist.
* @returns True if the table key did not already exist, otherwise False
*/
static bool SetDefaultStringArray(std::string_view key,
std::span<const std::string> defaultValue);
@@ -334,11 +334,11 @@ class SmartDashboard {
static 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 the value in the table if key does not exist.
*
* @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
* @param defaultValue The value to set if key doesn't exist.
* @returns True if the table key did not already exist, otherwise False
*/
static bool SetDefaultRaw(std::string_view key,
std::span<const uint8_t> defaultValue);
@@ -374,11 +374,11 @@ class SmartDashboard {
static bool PutValue(std::string_view keyName, const nt::Value& value);
/**
* Gets the current value in the table, setting it if it does not exist.
* Set the value in the table if key does not exist.
*
* @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
* @param defaultValue The value to set if key doesn't exist.
* @returns True if the table key did not already exist, otherwise False
*/
static bool SetDefaultValue(std::string_view key,
const nt::Value& defaultValue);