From a9652ef45d9989ea962c435aaee9a9dee2a1f877 Mon Sep 17 00:00:00 2001 From: Ryan Blue Date: Tue, 15 Oct 2024 23:41:34 -0400 Subject: [PATCH] docs --- hal/src/main/native/include/hal/SPI.h | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/hal/src/main/native/include/hal/SPI.h b/hal/src/main/native/include/hal/SPI.h index ddf5527fa35..d39f8938d93 100644 --- a/hal/src/main/native/include/hal/SPI.h +++ b/hal/src/main/native/include/hal/SPI.h @@ -21,13 +21,14 @@ extern "C" { #endif /** - * Initializes the SPI port. Opens the port if necessary and saves the handle. + * Initializes the SPI port and returns a handle. * * If opening the MXP port, also sets up the channel functions appropriately. + * TODO: @thad what does this mean? Is this just DIO 14-17 being reserved for + * SPI? * - * @param[in] port The number of the port to use. 0-3 for Onboard CS0-CS3, 4 - * for MXP - * @param[out] status the error code, or 0 for success + * @param[in] port The port to initialize. + * @param[out] status the error code, or 0 for success. */ void HAL_InitializeSPI(HAL_SPIPort port, int32_t* status);