[docs] Fix Doxygen warnings, add CI docs lint job (#3639)

The CI docs lint build is configured to fail on Doxygen warnings.
This commit is contained in:
Tyler Veness
2021-10-14 18:09:38 -07:00
committed by GitHub
parent 4ad3a54026
commit 4647d09b50
125 changed files with 1723 additions and 1131 deletions

View File

@@ -242,7 +242,7 @@ class NetworkTableEntry final {
/**
* Sets the entry's value if it does not exist.
*
* @param defaultValue the default value to set
* @param value the default value to set
* @return False if the entry exists with a different type
*/
bool SetDefaultValue(std::shared_ptr<Value> value);

View File

@@ -85,7 +85,7 @@ class NetworkTableInstance final {
/**
* Construct from native handle.
*
* @param handle Native handle
* @param inst Native handle
*/
explicit NetworkTableInstance(NT_Inst inst) noexcept;
@@ -523,7 +523,7 @@ class NetworkTableInstance final {
* @return Logger handle
*/
NT_Logger AddLogger(std::function<void(const LogMessage& msg)> func,
unsigned int min_level, unsigned int max_level);
unsigned int minLevel, unsigned int maxLevel);
/**
* Remove a logger.

View File

@@ -325,11 +325,13 @@ NT_Entry NT_GetEntry(NT_Inst inst, const char* name, size_t name_len);
* filtered by string prefix and entry type to only return a subset of all
* entries.
*
* @param prefix entry name required prefix; only entries whose name
* starts with this string are returned
* @param prefix_len length of prefix in bytes
* @param types bitmask of NT_Type values; 0 is treated specially
* as a "don't care"
* @param inst NetworkTable instance
* @param prefix entry name required prefix; only entries whose name starts
* with this string are returned
* @param prefix_len length of prefix in bytes
* @param types bitmask of NT_Type values; 0 is treated specially as a
* "don't care"
* @param count stores number of entry handles returned
* @return Array of entry handles.
*/
NT_Entry* NT_GetEntries(NT_Inst inst, const char* prefix, size_t prefix_len,
@@ -570,6 +572,7 @@ void NT_DestroyEntryListenerPoller(NT_EntryListenerPoller poller);
*
* @param poller poller handle
* @param prefix UTF-8 string prefix
* @param prefix_len Length of UTF-8 string prefix
* @param flags NT_NotifyKind bitmask
* @return Listener handle
*/
@@ -583,7 +586,7 @@ NT_EntryListener NT_AddPolledEntryListener(NT_EntryListenerPoller poller,
* The caller is responsible for calling NT_PollEntryListener() to poll.
*
* @param poller poller handle
* @param prefix UTF-8 string prefix
* @param entry entry handle
* @param flags NT_NotifyKind bitmask
* @return Listener handle
*/
@@ -1592,21 +1595,21 @@ struct NT_String* NT_AllocateStringArray(size_t size);
/**
* Frees an array of chars.
*
* @param v_boolean pointer to the char array to free
* @param v_char pointer to the char array to free
*/
void NT_FreeCharArray(char* v_char);
/**
* Frees an array of doubles.
*
* @param v_boolean pointer to the double array to free
* @param v_double pointer to the double array to free
*/
void NT_FreeDoubleArray(double* v_double);
/**
* Frees an array of booleans.
*
* @param v_boolean pointer to the boolean array to free
* @param v_boolean pointer to the boolean array to free
*/
void NT_FreeBooleanArray(NT_Bool* v_boolean);

View File

@@ -585,7 +585,7 @@ NT_EntryListener AddPolledEntryListener(NT_EntryListenerPoller poller,
* The caller is responsible for calling PollEntryListener() to poll.
*
* @param poller poller handle
* @param prefix UTF-8 string prefix
* @param entry entry handle
* @param flags NotifyKind bitmask
* @return Listener handle
*/