Skip to content
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.

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

uart.h: Some function prototypes look inconsistent #105

Closed
krzychb opened this issue Nov 17, 2016 · 1 comment
Closed

uart.h: Some function prototypes look inconsistent #105

krzychb opened this issue Nov 17, 2016 · 1 comment

Comments

@krzychb
Copy link
Collaborator

krzychb commented Nov 17, 2016

Hi,

Thank you for mass update of in-line documentation for uart.h in d7599ab
I find it easier to follow now - http://esp-idf.readthedocs.io/en/latest/api/uart.html

I have question regarding "sister" function prototypes like below;

esp_err_t uart_set_baudrate(uart_port_t uart_num, uint32_t baud_rate);
esp_err_t uart_get_baudrate(uart_port_t uart_num, uint32_t* baudrate);

esp_err_t uart_set_stop_bits(uart_port_t uart_num, uart_stop_bits_t bit_num);
esp_err_t uart_get_stop_bits(uart_port_t uart_num, uart_stop_bits_t* stop_bit);

Is there a reason for different name of baud rate or stop bits?

igrr added a commit that referenced this issue Nov 24, 2016
uart: use same argument names in get/set functions

This one is pretty trivial: rename arguments so that same name is used for get and set functions.

#105

See merge request !248
@igrr
Copy link
Member

igrr commented Nov 24, 2016

Fixed in 79482bb.

@igrr igrr closed this as completed Nov 24, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants