win: Add note on how COM port is created

serialport · Jun 28, 2022 · ebe786e · ebe786e
1 parent 69529a7
commit ebe786e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/windows/com.rs b/src/windows/com.rs
@@ -67,6 +67,8 @@ impl Drop for OverlappedHandle {
 /// should not be instantiated directly by using `COMPort::open()`, instead use
 /// the cross-platform `serialport::open()` or
 /// `serialport::open_with_settings()`.
+///
+/// Port is created using `CreateFileW` syscall with following set of flags: `FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED`
 #[derive(Debug)]
 pub struct COMPort {
     handle: HANDLE,