From 5bcf4ed83aaf2fdab85123382b20409f961407d4 Mon Sep 17 00:00:00 2001 From: Andrew Scheller Date: Wed, 19 Jan 2022 15:30:21 +0000 Subject: [PATCH] Clarify header-comments about pico_enable_stdio_ CMake-functions (#705) --- .../pico_stdio_semihosting/include/pico/stdio_semihosting.h | 2 +- src/rp2_common/pico_stdio_uart/include/pico/stdio_uart.h | 4 ++-- src/rp2_common/pico_stdio_usb/include/pico/stdio_usb.h | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/src/rp2_common/pico_stdio_semihosting/include/pico/stdio_semihosting.h b/src/rp2_common/pico_stdio_semihosting/include/pico/stdio_semihosting.h index 3304368..ca66417 100644 --- a/src/rp2_common/pico_stdio_semihosting/include/pico/stdio_semihosting.h +++ b/src/rp2_common/pico_stdio_semihosting/include/pico/stdio_semihosting.h @@ -13,7 +13,7 @@ * \defgroup pico_stdio_semihosting pico_stdio_semihosting * \ingroup pico_stdio * - * Linking this library or calling `pico_enable_stdio_semihosting(TARGET)` in the CMake (which + * Linking this library or calling `pico_enable_stdio_semihosting(TARGET ENABLED)` in the CMake (which * achieves the same thing) will add semihosting to the drivers used for standard output */ diff --git a/src/rp2_common/pico_stdio_uart/include/pico/stdio_uart.h b/src/rp2_common/pico_stdio_uart/include/pico/stdio_uart.h index 5afe910..9e5ac53 100644 --- a/src/rp2_common/pico_stdio_uart/include/pico/stdio_uart.h +++ b/src/rp2_common/pico_stdio_uart/include/pico/stdio_uart.h @@ -14,8 +14,8 @@ * \defgroup pico_stdio_uart pico_stdio_uart * \ingroup pico_stdio * - * Linking this library or calling `pico_enable_stdio_uart(TARGET)` in the CMake (which - * achieves the same thing) will add UART to the drivers used for standard output + * Linking this library or calling `pico_enable_stdio_uart(TARGET ENABLED)` in the CMake (which + * achieves the same thing) will add UART to the drivers used for standard input/output */ // PICO_CONFIG: PICO_STDIO_UART_DEFAULT_CRLF, Default state of CR/LF translation for UART output, type=bool, default=PICO_STDIO_DEFAULT_CRLF, group=pico_stdio_uart diff --git a/src/rp2_common/pico_stdio_usb/include/pico/stdio_usb.h b/src/rp2_common/pico_stdio_usb/include/pico/stdio_usb.h index 2aeb647..c1ace03 100644 --- a/src/rp2_common/pico_stdio_usb/include/pico/stdio_usb.h +++ b/src/rp2_common/pico_stdio_usb/include/pico/stdio_usb.h @@ -13,8 +13,8 @@ * \defgroup pico_stdio_usb pico_stdio_usb * \ingroup pico_stdio * - * Linking this library or calling `pico_enable_stdio_usb(TARGET)` in the CMake (which - * achieves the same thing) will add USB CDC to the drivers used for standard output + * Linking this library or calling `pico_enable_stdio_usb(TARGET ENABLED)` in the CMake (which + * achieves the same thing) will add USB CDC to the drivers used for standard input/output * * Note this library is a developer convenience. It is not applicable in all cases; for one it takes full control of the USB device precluding your * use of the USB in device or host mode. For this reason, this library will automatically disengage if you try to using it alongside \ref tinyusb_device or