Skip to content

Remove accidental comment words in stdio.h #2480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Remove accidental comment words in stdio.h #2480

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/rp2_common/pico_stdio/include/pico/stdio.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,35 +186,35 @@ int stdio_get_until(char *buf, int len, absolute_time_t until);
*/
int stdio_put_string(const char *s, int len, bool newline, bool cr_translation);

/*! \brief stdio_getchar Alias for \ref getchar that definitely does not go thru the implementation
Copy link

@robertrico robertrico May 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one is right, the others may need to be renamed not removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I wasn't sure - I'll wait to see what @kilograham says...
(but if your supposition is correct, we'll still need to change "Alias" to "alias")

/*! \brief Alias for \ref getchar that definitely does not go thru the implementation
* in the standard C library even when \ref PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS == 0
*
* \ingroup pico_stdio
*/
int stdio_getchar(void);

/*! \brief stdio_getchar Alias for \ref putchar that definitely does not go thru the implementation
/*! \brief Alias for \ref putchar that definitely does not go thru the implementation
Copy link

@robertrico robertrico May 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this should be stdio_putchar. The following removals of stdio_getchar perhaps should change to the prototype fn name.

* in the standard C library even when \ref PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS == 0
*
* \ingroup pico_stdio
*/
int stdio_putchar(int);

/*! \brief stdio_getchar Alias for \ref puts that definitely does not go thru the implementation
/*! \brief Alias for \ref puts that definitely does not go thru the implementation
* in the standard C library even when \ref PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS == 0
*
* \ingroup pico_stdio
*/
int stdio_puts(const char *s);

/*! \brief stdio_getchar Alias for \ref vprintf that definitely does not go thru the implementation
/*! \brief Alias for \ref vprintf that definitely does not go thru the implementation
* in the standard C library even when \ref PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS == 0
*
* \ingroup pico_stdio
*/
int stdio_vprintf(const char *format, va_list va);

/*! \brief stdio_getchar Alias for \ref printf that definitely does not go thru the implementation
/*! \brief Alias for \ref printf that definitely does not go thru the implementation
* in the standard C library even when \ref PICO_STDIO_SHORT_CIRCUIT_CLIB_FUNCS == 0
*
* \ingroup pico_stdio
Expand Down
Loading