Skip to content

Commit 9ff2e5a

Browse files
committed
Update .gitignore and CMakeLists.txt; refine documentation in serial interface headers
- Added `.cache/` to `.gitignore` to exclude cache files from version control. - Removed unnecessary whitespace in `CMakeLists.txt` for cleaner formatting. - Clarified return value documentation in `serial_drain.h` and `serial_open.h` to improve understanding of function outcomes. These changes enhance project organization and improve code documentation clarity.
1 parent bb57b7c commit 9ff2e5a

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
include/cpp_core/version.h
22
build/
3-
3+
.cache/
44

CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,4 @@ install(EXPORT cpp_coreTargets
6161
install(FILES
6262
${CMAKE_CURRENT_BINARY_DIR}/cpp_coreConfig.cmake
6363
${CMAKE_CURRENT_BINARY_DIR}/cpp_coreConfigVersion.cmake
64-
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/cpp_core)
64+
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/cpp_core)

include/cpp_core/interface/serial_drain.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ extern "C"
2929
*
3030
* @param handle Port handle.
3131
* @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`.
32-
* @return 0 on success; negative ::cpp_core::StatusCodes value on error.
32+
* @return 0 on success or a negative error code on failure.
3333
*/
3434
MODULE_API auto serialDrain(
3535
int64_t handle,

include/cpp_core/interface/serial_open.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ extern "C"
1717
* - `const wchar_t*` on Windows.
1818
*
1919
* @param port Null-terminated device identifier (e.g. "COM3", "/dev/ttyUSB0"). Passing `nullptr` results in
20-
* ::cpp_core::StatusCodes::kNotFoundError.
20+
* a failure.
2121
* @param baudrate Desired baud rate in bit/s (≥ 300).
2222
* @param data_bits Number of data bits (5–8).
2323
* @param parity 0 = none, 1 = even, 2 = odd.
2424
* @param stop_bits 0 = 1 stop bit, 2 = 2 stop bits.
2525
* @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`.
26-
* @return A positive opaque handle on success or a negative value from ::cpp_core::StatusCodes on failure.
26+
* @return A positive opaque handle on success or a negative value on failure.
2727
*/
2828
MODULE_API auto serialOpen(
2929
void *port,

0 commit comments

Comments
 (0)