vt: update terminal.h docs

This commit is contained in:
Mitchell Hashimoto
2026-03-13 19:59:06 -07:00
parent aa3e6e23a2
commit 34acdfcc4e
2 changed files with 6 additions and 6 deletions

View File

@@ -28,7 +28,7 @@
* @section groups_sec API Reference
*
* The API is organized into the following groups:
* - @ref terminal "Terminal Lifecycle" - Create and destroy terminal instances
* - @ref terminal "Terminal" - Complete terminal emulator state and rendering
* - @ref key "Key Encoding" - Encode key events into terminal sequences
* - @ref osc "OSC Parser" - Parse OSC (Operating System Command) sequences
* - @ref sgr "SGR Parser" - Parse SGR (Select Graphic Rendition) sequences

View File

@@ -1,7 +1,7 @@
/**
* @file terminal.h
*
* Terminal lifecycle management.
* Complete terminal emulator state and rendering.
*/
#ifndef GHOSTTY_VT_TERMINAL_H
@@ -16,12 +16,12 @@
extern "C" {
#endif
/** @defgroup terminal Terminal Lifecycle
/** @defgroup terminal Terminal
*
* Minimal API for creating and destroying terminal instances.
* Complete terminal emulator state and rendering.
*
* This currently only exposes lifecycle operations. Additional terminal
* APIs will be added over time.
* A terminal instance manages the full emulator state including the screen,
* scrollback, cursor, styles, modes, and VT stream processing.
*
* @{
*/