blasthavers/minicrossterm
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix links in docs (#639)

Browse Source
This commit is contained in:
yjhn 2022-03-15 22:48:38 +02:00 committed by GitHub
parent 72ce50ef49
commit 0cb34f1df2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/command.rs
View File

@ -8,13 +8,13 @@ use super::error::Result;
/// Crossterm provides a set of commands, /// Crossterm provides a set of commands,
/// and there is no immediate reason to implement a command yourself. /// and there is no immediate reason to implement a command yourself.
/// In order to understand how to use and execute commands, /// In order to understand how to use and execute commands,
/// it is recommended that you take a look at [Command API](../#command-api) chapter. /// it is recommended that you take a look at [Command API](./index.html#command-api) chapter.
pub trait Command { pub trait Command {
/// Write an ANSI representation of this command to the given writer. /// Write an ANSI representation of this command to the given writer.
/// An ANSI code can manipulate the terminal by writing it to the terminal buffer. /// An ANSI code can manipulate the terminal by writing it to the terminal buffer.
/// However, only Windows 10 and UNIX systems support this. /// However, only Windows 10 and UNIX systems support this.
/// ///
/// This method does not need to be accessed manually, as it is used by the crossterm's [Command API](../#command-api) /// This method does not need to be accessed manually, as it is used by the crossterm's [Command API](./index.html#command-api)
fn write_ansi(&self, f: &mut impl fmt::Write) -> fmt::Result; fn write_ansi(&self, f: &mut impl fmt::Write) -> fmt::Result;
/// Execute this command. /// Execute this command.
@ -22,7 +22,7 @@ pub trait Command {
/// Windows versions lower than windows 10 do not support ANSI escape codes, /// Windows versions lower than windows 10 do not support ANSI escape codes,
/// therefore a direct WinAPI call is made. /// therefore a direct WinAPI call is made.
/// ///
/// This method does not need to be accessed manually, as it is used by the crossterm's [Command API](../#command-api) /// This method does not need to be accessed manually, as it is used by the crossterm's [Command API](./index.html#command-api)
#[cfg(windows)] #[cfg(windows)]
fn execute_winapi(&self) -> Result<()>; fn execute_winapi(&self) -> Result<()>;
@ -109,7 +109,7 @@ impl<T: Write + ?Sized> QueueableCommand for T {
/// } /// }
/// ``` /// ```
/// ///
/// Have a look over at the [Command API](./#command-api) for more details. /// Have a look over at the [Command API](./index.html#command-api) for more details.
/// ///
/// # Notes /// # Notes
/// ///
@ -167,7 +167,7 @@ impl<T: Write + ?Sized> ExecutableCommand for T {
/// } /// }
/// ``` /// ```
/// ///
/// Have a look over at the [Command API](./#command-api) for more details. /// Have a look over at the [Command API](./index.html#command-api) for more details.
/// ///
/// # Notes /// # Notes
/// ///

4
src/event.rs
View File

@ -15,12 +15,12 @@
//! * use the [`read`](fn.read.html) & [`poll`](fn.poll.html) functions on any, but same, thread //! * use the [`read`](fn.read.html) & [`poll`](fn.poll.html) functions on any, but same, thread
//! * or the [`EventStream`](struct.EventStream.html). //! * or the [`EventStream`](struct.EventStream.html).
//! //!
//! **Make sure to enable [raw mode](../terminal/#raw-mode) in order for keyboard events to work properly** //! **Make sure to enable [raw mode](./terminal/index.html#raw-mode) in order for keyboard events to work properly**
//! //!
//! ## Mouse Events //! ## Mouse Events
//! //!
//! Mouse events are not enabled by default. You have to enable them with the //! Mouse events are not enabled by default. You have to enable them with the
//! [`EnableMouseCapture`](struct.EnableMouseCapture.html) command. See [Command API](../index.html#command-api) //! [`EnableMouseCapture`](struct.EnableMouseCapture.html) command. See [Command API](./index.html#command-api)
//! for more information. //! for more information.
//! //!
//! ## Examples //! ## Examples

4
src/macros.rs
View File

@ -44,7 +44,7 @@ macro_rules! csi {
/// // foo /// // foo
/// ``` /// ```
/// ///
/// Have a look over at the [Command API](./#command-api) for more details. /// Have a look over at the [Command API](./index.html#command-api) for more details.
/// ///
/// # Notes /// # Notes
/// ///
@ -95,7 +95,7 @@ macro_rules! queue {
/// // 1 + 1 = 2 /// // 1 + 1 = 2
/// ``` /// ```
/// ///
/// Have a look over at the [Command API](./#command-api) for more details. /// Have a look over at the [Command API](./index.html#command-api) for more details.
/// ///
/// # Notes /// # Notes
/// ///

6
src/terminal.rs
View File

@ -100,7 +100,7 @@ pub(crate) mod sys;
/// Tells whether the raw mode is enabled. /// Tells whether the raw mode is enabled.
/// ///
/// Please have a look at the [raw mode](./#raw-mode) section. /// Please have a look at the [raw mode](./index.html#raw-mode) section.
pub fn is_raw_mode_enabled() -> Result<bool> { pub fn is_raw_mode_enabled() -> Result<bool> {
#[cfg(unix)] #[cfg(unix)]
{ {
@ -115,14 +115,14 @@ pub fn is_raw_mode_enabled() -> Result<bool> {
/// Enables raw mode. /// Enables raw mode.
/// ///
/// Please have a look at the [raw mode](./#raw-mode) section. /// Please have a look at the [raw mode](./index.html#raw-mode) section.
pub fn enable_raw_mode() -> Result<()> { pub fn enable_raw_mode() -> Result<()> {
sys::enable_raw_mode() sys::enable_raw_mode()
} }
/// Disables raw mode. /// Disables raw mode.
/// ///
/// Please have a look at the [raw mode](./#raw-mode) section. /// Please have a look at the [raw mode](./index.html#raw-mode) section.
pub fn disable_raw_mode() -> Result<()> { pub fn disable_raw_mode() -> Result<()> {
sys::disable_raw_mode() sys::disable_raw_mode()
} }