Skip to content

Clarify documentation for serial_open.h to specify that the port para… #14

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

Merged
Mqxx merged 1 commit into from
Feb 22, 2026
Merged

Clarify documentation for serial_open.h to specify that the port para… #14

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
3 changes: 1 addition & 2 deletions include/cpp_core/interface/serial_open.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ extern "C"
*
* The function attempts to open the device referenced by @p port and applies
* the given line settings. The pointer is interpreted as
* - `const char*` on POSIX and
* - `const wchar_t*` on Windows.
* a UTF-8 encoded null-terminated string (`const char*`) on all platforms.
*
* @param port Null-terminated device identifier (e.g. "COM3", "/dev/ttyUSB0"). Passing `nullptr` results in
* a failure.
Expand Down