Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'helix-tui/src/terminal.rs')
-rw-r--r--helix-tui/src/terminal.rs6
1 files changed, 5 insertions, 1 deletions
diff --git a/helix-tui/src/terminal.rs b/helix-tui/src/terminal.rs
index d2a911cf..969b285c 100644
--- a/helix-tui/src/terminal.rs
+++ b/helix-tui/src/terminal.rs
@@ -1,3 +1,6 @@
+//! Terminal interface provided through the [Terminal] type.
+//! Frontend for [Backend]
+
use crate::{backend::Backend, buffer::Buffer};
use helix_view::editor::Config as EditorConfig;
use helix_view::graphics::{CursorKind, Rect};
@@ -17,6 +20,7 @@ pub struct Viewport {
resize_behavior: ResizeBehavior,
}
+/// Terminal configuration
#[derive(Debug)]
pub struct Config {
pub enable_mouse_capture: bool,
@@ -47,7 +51,7 @@ pub struct TerminalOptions {
pub viewport: Viewport,
}
-/// Interface to the terminal backed by Termion
+/// Interface to the terminal backed by crossterm
#[derive(Debug)]
pub struct Terminal<B>
where