Clarify header-comments about pico_enable_stdio_ CMake-functions (#705)

This commit is contained in:
Andrew Scheller 2022-01-19 15:30:21 +00:00 committed by GitHub
parent e379f6764b
commit 5bcf4ed83a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 5 deletions

View File

@ -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
*/

View File

@ -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

View File

@ -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