issue #1219 doxygen comments in uart.h #1223

Merged

bradselb merged 1 commit from uart_h_docs into develop

2023-02-05 19:00:26 -06:00

bradselb commented

2023-02-05 17:16:51 -06:00

(Migrated from github.com)

Fixes issue #1219
Makes minor revisions to the doxygen comments in the header file. Comments only, no functional changes.

minor grammatical corrections in comments for uart_getc()
in the comments for uart_read_blocking(), make the description more specific and a tiny bit clearer.
in the comments for uart_is_readable() make the description of what the function returns agree with the function return type.

This is my first ever contribution to an open source project. With this PR, I'm trying to learn the process while contributing something useful but innocuous. Any feedback is much appreciated.

Fixes issue #1219 Makes minor revisions to the doxygen comments in the header file. Comments only, no functional changes. - minor grammatical corrections in comments for uart_getc() - in the comments for uart_read_blocking(), make the description more specific and a tiny bit clearer. - in the comments for uart_is_readable() make the description of what the function returns agree with the function return type. This is my first ever contribution to an open source project. With this PR, I'm trying to learn the process while contributing something useful but innocuous. Any feedback is much appreciated.

🚀 1

bradselb commented

2023-02-05 17:26:02 -06:00

(Migrated from github.com)

I'm sorry. Looks like I've screwed up. It should have been a very simple change. I see it thinks I want to merge to master.
How can I fix this? Any suggestions?

I'm sorry. Looks like I've screwed up. It should have been a very simple change. I see it thinks I want to merge to master. How can I fix this? Any suggestions?

Rows
Columns