diff --git a/src/ansi.rs b/src/ansi.rs index 5ad675e..e6da106 100644 --- a/src/ansi.rs +++ b/src/ansi.rs @@ -1,8 +1,8 @@ -//! Collection of ANSI escape code consts/functions +//! Collection of ANSI escape code utilities //! -//! These should work on *most* terminals (i.e. Xterm compatible terminals) +//! These should work on *most* terminals //! -//! For these to work on Windows you need to run the `enable_ansi` function inside this module +//! For these to always work on Windows you need to run the `enable_ansi` function inside this module use std::io::{self, Write}; diff --git a/src/control.rs b/src/control.rs index 277fe8b..8c61a83 100644 --- a/src/control.rs +++ b/src/control.rs @@ -1,4 +1,4 @@ -//! Collection of functions that help control the terminal +//! Utilities that help control the terminal //! //! These are built to work on Windows, Linux, and MacOS diff --git a/src/input.rs b/src/input.rs index a904c8b..57da89f 100644 --- a/src/input.rs +++ b/src/input.rs @@ -1,4 +1,4 @@ -//! Various input functions, structs, etc. +//! Input Utilities //! //! Very incomplete currently //! diff --git a/src/lib.rs b/src/lib.rs index 403085b..e3a53f7 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -11,6 +11,8 @@ //! - [x] Output (Windows) //! - [x] Input (Unix) (Appears to work, more testing needed) //! - [ ] Input (Windows) (WIP) +//! - [ ] Advanced Input (Kitty-like) +//! - [ ] Advanced Input (Windows) //! - [ ] Events (Focus reporting, Bracketed-paste) (Unix) //! - [ ] Events (Focus reporting, Bracketed-paste) (Windows) //! - [ ] Mouse input (Unix) @@ -27,18 +29,16 @@ //! work as this library is work in progress but eventually will be //! //! Just because a protocol is listed as not planned doesn't mean it definetly won't be added but -//! it is most likely a no without good reason -//! - Standard Windows terminals (Full support planned)* +//! it is most likely not without good reason +//! - Standard Windows terminals (Full support planned)\* //! - WinPTY (Windows psuedo-terminals) (Full support planned) -//! - Standard *nix terminals (Full support planned)** +//! - Standard \*nix terminals (Full support planned)\* //! - OSC 52 system clipboard (Full support planned) //! - Kitty comprehensive keyboard handling (Full support planned) //! - Kitty colored and styled underlines (Full support planned) //! - Other Kitty protocols (there are a lot of them) (Not planned) //! -//! \* Standard Windows termian -//! -//! \** Standard *nix terminals do not have support for some advanced input +//! \* Do not have full support for advanced input #[cfg(unix)] mod unix;