From f6135befedb7da8603ecff2c59b155effd0183db Mon Sep 17 00:00:00 2001 From: Paul Buetow Date: Thu, 5 Mar 2026 23:51:59 +0200 Subject: Add package-level docs across internal packages --- internal/tui/common/doc.go | 2 ++ internal/tui/dashboard/doc.go | 2 ++ internal/tui/doc.go | 2 ++ internal/tui/eventstream/doc.go | 2 ++ internal/tui/export/doc.go | 2 ++ internal/tui/flamegraph/doc.go | 2 ++ internal/tui/messages/doc.go | 2 ++ internal/tui/pidpicker/doc.go | 2 ++ internal/tui/probes/doc.go | 2 ++ 9 files changed, 18 insertions(+) create mode 100644 internal/tui/common/doc.go create mode 100644 internal/tui/dashboard/doc.go create mode 100644 internal/tui/doc.go create mode 100644 internal/tui/eventstream/doc.go create mode 100644 internal/tui/export/doc.go create mode 100644 internal/tui/flamegraph/doc.go create mode 100644 internal/tui/messages/doc.go create mode 100644 internal/tui/pidpicker/doc.go create mode 100644 internal/tui/probes/doc.go (limited to 'internal/tui') diff --git a/internal/tui/common/doc.go b/internal/tui/common/doc.go new file mode 100644 index 0000000..e15ceb7 --- /dev/null +++ b/internal/tui/common/doc.go @@ -0,0 +1,2 @@ +// Package common provides shared TUI styling, keymaps, and viewport utilities. +package common diff --git a/internal/tui/dashboard/doc.go b/internal/tui/dashboard/doc.go new file mode 100644 index 0000000..b9bc30e --- /dev/null +++ b/internal/tui/dashboard/doc.go @@ -0,0 +1,2 @@ +// Package dashboard implements the multi-tab runtime dashboard used in TUI mode. +package dashboard diff --git a/internal/tui/doc.go b/internal/tui/doc.go new file mode 100644 index 0000000..3175d65 --- /dev/null +++ b/internal/tui/doc.go @@ -0,0 +1,2 @@ +// Package tui hosts the top-level terminal UI model and screen routing. +package tui diff --git a/internal/tui/eventstream/doc.go b/internal/tui/eventstream/doc.go new file mode 100644 index 0000000..38bc854 --- /dev/null +++ b/internal/tui/eventstream/doc.go @@ -0,0 +1,2 @@ +// Package eventstream renders live event rows and interactive filtering controls. +package eventstream diff --git a/internal/tui/export/doc.go b/internal/tui/export/doc.go new file mode 100644 index 0000000..356b800 --- /dev/null +++ b/internal/tui/export/doc.go @@ -0,0 +1,2 @@ +// Package export implements the TUI snapshot export modal and option handling. +package export diff --git a/internal/tui/flamegraph/doc.go b/internal/tui/flamegraph/doc.go new file mode 100644 index 0000000..7982ae9 --- /dev/null +++ b/internal/tui/flamegraph/doc.go @@ -0,0 +1,2 @@ +// Package flamegraph renders the interactive terminal flamegraph dashboard tab. +package flamegraph diff --git a/internal/tui/messages/doc.go b/internal/tui/messages/doc.go new file mode 100644 index 0000000..8d70859 --- /dev/null +++ b/internal/tui/messages/doc.go @@ -0,0 +1,2 @@ +// Package messages defines typed Bubble Tea messages exchanged across TUI models. +package messages diff --git a/internal/tui/pidpicker/doc.go b/internal/tui/pidpicker/doc.go new file mode 100644 index 0000000..5f863c0 --- /dev/null +++ b/internal/tui/pidpicker/doc.go @@ -0,0 +1,2 @@ +// Package pidpicker implements PID and TID selection workflows before tracing starts. +package pidpicker diff --git a/internal/tui/probes/doc.go b/internal/tui/probes/doc.go new file mode 100644 index 0000000..922aee6 --- /dev/null +++ b/internal/tui/probes/doc.go @@ -0,0 +1,2 @@ +// Package probes implements the runtime probe toggling modal for the TUI. +package probes -- cgit v1.2.3