Skip to content

Commit d7b2628

Browse files
lambdalisueclaude
andcommitted
docs: add JSDoc documentation to component modules
- Document input.ts for user input management - Document list.ts for item display and selection - Document preview.ts for content preview functionality - Document help.ts for interactive help system - Include module-level documentation explaining each component's role 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 291f177 commit d7b2628

File tree

4 files changed

+61
-0
lines changed

4 files changed

+61
-0
lines changed

denops/fall/component/help.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
/**
2+
* @module component/help
3+
*
4+
* Help component for the vim-fall picker UI.
5+
*
6+
* This module provides the HelpComponent class which displays interactive help
7+
* information to users. It supports:
8+
*
9+
* - Multi-page help content with navigation
10+
* - Syntax highlighting through decorations
11+
* - Dynamic content generation based on current mappings
12+
* - Toggle visibility with F1 key
13+
*
14+
* The help component provides contextual assistance, showing available
15+
* keyboard shortcuts and commands for the current picker.
16+
*/
17+
118
import type { Denops } from "jsr:@denops/std@^7.3.2";
219
import type { Decoration } from "jsr:@denops/std@^7.3.2/buffer";
320
import * as mapping from "jsr:@denops/std@^7.3.2/mapping";

denops/fall/component/input.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
/**
2+
* @module component/input
3+
*
4+
* Input component for the vim-fall picker UI.
5+
*
6+
* This module provides the InputComponent class which manages the user input area
7+
* of the picker. It displays the current query, cursor position, collection/processing
8+
* status, and provides visual feedback through spinners and status indicators.
9+
*/
10+
111
import type { Denops } from "jsr:@denops/std@^7.3.2";
212
import * as fn from "jsr:@denops/std@^7.3.2/function";
313
import * as buffer from "jsr:@denops/std@^7.3.2/buffer";

denops/fall/component/list.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
/**
2+
* @module component/list
3+
*
4+
* List component for the vim-fall picker UI.
5+
*
6+
* This module provides the ListComponent class which manages the main list area
7+
* of the picker where filtered and rendered items are displayed. It handles:
8+
*
9+
* - Rendering items with syntax highlighting
10+
* - Managing item selection with visual indicators
11+
* - Executing commands on the list buffer
12+
* - Handling decorations for match highlighting
13+
*
14+
* The list component works closely with the render processor to display
15+
* items in a scrollable, interactive list format.
16+
*/
17+
118
import type { Denops } from "jsr:@denops/std@^7.3.2";
219
import type { Decoration } from "jsr:@denops/std@^7.3.2/buffer";
320
import { batch } from "jsr:@denops/std@^7.3.2/batch";

denops/fall/component/preview.ts

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,20 @@
1+
/**
2+
* @module component/preview
3+
*
4+
* Preview component for the vim-fall picker UI.
5+
*
6+
* This module provides the PreviewComponent class which displays previews of
7+
* selected items in the picker. It supports:
8+
*
9+
* - Content preview with optional syntax highlighting
10+
* - Cursor positioning at specific lines/columns
11+
* - File type detection for proper highlighting
12+
* - Command execution within the preview context
13+
*
14+
* The preview component enhances the user experience by showing item details
15+
* before selection, making it easier to identify the desired item.
16+
*/
17+
118
import type { Denops } from "jsr:@denops/std@^7.3.2";
219
import * as fn from "jsr:@denops/std@^7.3.2/function";
320
import * as buffer from "jsr:@denops/std@^7.3.2/buffer";

0 commit comments

Comments
 (0)