gpui: Store action documentation (#33809)

Closes #ISSUE

Adds a new `documentation` method to actions, that is extracted from doc
comments when using the `actions!` or derive macros.

Additionally, this PR adds doc comments to as many action definitions in
Zed as possible.

Release Notes:

- N/A *or* Added/Fixed/Improved ...
This commit is contained in:
Ben Kunkle 2025-07-02 20:14:33 -05:00 committed by GitHub
parent def8bab5a8
commit 6cd4dbdea1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
96 changed files with 1467 additions and 78 deletions

View file

@ -13,7 +13,13 @@ use ui::{
};
use workspace::{Item, SplitDirection, Workspace};
actions!(dev, [OpenKeyContextView]);
actions!(
dev,
[
/// Opens the key context view for debugging keybindings.
OpenKeyContextView
]
);
pub fn init(cx: &mut App) {
cx.observe_new(|workspace: &mut Workspace, _, _| {

View file

@ -204,7 +204,13 @@ pub(crate) struct LogMenuItem {
pub server_kind: LanguageServerKind,
}
actions!(dev, [OpenLanguageServerLogs]);
actions!(
dev,
[
/// Opens the language server protocol logs viewer.
OpenLanguageServerLogs
]
);
pub(super) struct GlobalLogStore(pub WeakEntity<LogStore>);

View file

@ -19,7 +19,13 @@ use workspace::{StatusItemView, Workspace};
use crate::lsp_log::GlobalLogStore;
actions!(lsp_tool, [ToggleMenu]);
actions!(
lsp_tool,
[
/// Toggles the language server tool menu.
ToggleMenu
]
);
pub struct LspTool {
state: Entity<PickerState>,

View file

@ -15,7 +15,13 @@ use workspace::{
item::{Item, ItemHandle},
};
actions!(dev, [OpenSyntaxTreeView]);
actions!(
dev,
[
/// Opens the syntax tree view for the current file.
OpenSyntaxTreeView
]
);
pub fn init(cx: &mut App) {
cx.observe_new(|workspace: &mut Workspace, _, _| {