[hal,wpilib] Update documentation for getComments (NFC) (#4879)

This commit is contained in:
Ryan Blue
2022-12-30 07:15:37 -05:00
committed by GitHub
parent c49a45abbd
commit fe1b62647f
3 changed files with 13 additions and 2 deletions

View File

@@ -77,14 +77,18 @@ int64_t HAL_GetFPGARevision(int32_t* status);
/**
* Returns the serial number.
*
* @return Serial number.
* @param[out] buffer The serial number.
* @param size The maximum characters to copy into buffer.
* @return Number of characters copied into buffer.
*/
size_t HAL_GetSerialNumber(char* buffer, size_t size);
/**
* Returns the comments from the roboRIO web interface.
*
* @return Comments.
* @param[out] buffer The comments string.
* @param size The maximum characters to copy into buffer.
* @return Number of characters copied into buffer.
*/
size_t HAL_GetComments(char* buffer, size_t size);