Add docstring for Windows set_console_mode()

djc · djc · commit 2f7184f4a175 · 2025-02-27T11:09:08.000+01:00
diff --git a/src/windows_term/mod.rs b/src/windows_term/mod.rs
@@ -78,6 +78,7 @@ pub(crate) fn is_a_color_terminal(out: &Term) -> bool {
     enable_ansi_on(out)
 }
 
+/// Enables or disables the `mode` flag on the given `HANDLE` and yields the previous mode.
 fn set_console_mode(handle: HANDLE, mode: CONSOLE_MODE, enable: bool) -> Option<CONSOLE_MODE> {
     unsafe {
         let mut dw_mode = 0;

Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,7 @@ pub(crate) fn is_a_color_terminal(out: &Term) -> bool {`
`78`	`78`	`enable_ansi_on(out)`
`79`	`79`	`}`
`80`	`80`
	`81`	+/// Enables or disables the `mode` flag on the given `HANDLE` and yields the previous mode.
`81`	`82`	`fn set_console_mode(handle: HANDLE, mode: CONSOLE_MODE, enable: bool) -> Option<CONSOLE_MODE> {`
`82`	`83`	`unsafe {`
`83`	`84`	`let mut dw_mode = 0;`