---
id: TASK-3.3
title: Update docs in commands module and shared utils
status: Done
assignee:
  - codex
created_date: '2026-01-29 18:35'
updated_date: '2026-01-29 18:48'
labels: []
dependencies: []
references:
  - lua/zync/api/commands/commands.lua
  - lua/zync/api/commands/Command.lua
  - lua/zync/lib/utils.lua
parent_task_id: TASK-3
---

## Description

<!-- SECTION:DESCRIPTION:BEGIN -->
Add or refresh LuaDoc annotations and comments in `lua/zync/api/commands/*` and `lua/zync/lib/utils.lua` to keep command metadata, arg parsing, and helper utilities well documented and consistent.
<!-- SECTION:DESCRIPTION:END -->

## Acceptance Criteria
<!-- AC:BEGIN -->
- [x] #1 Commands module documents command registration and argument wiring, including `profiles` command
- [x] #2 Command class parsing/dispatch logic has updated annotations where needed
- [x] #3 Utility helpers used by CLI/manager have concise doc comments where missing
- [x] #4 No functional code changes
<!-- AC:END -->

## Implementation Plan

<!-- SECTION:PLAN:BEGIN -->
1) Review `lua/zync/api/commands/commands.lua`, `lua/zync/api/commands/Command.lua`, and `lua/zync/lib/utils.lua` for missing or inconsistent LuaDoc blocks.
2) Add/refresh docs for command registration/arg wiring, including `profiles`.
3) Update Command class parsing/dispatch LuaDoc where needed.
4) Add concise utility doc comments where missing.
5) Keep blank-line formatting consistent and avoid functional changes.
<!-- SECTION:PLAN:END -->

## Implementation Notes

<!-- SECTION:NOTES:BEGIN -->
Updated LuaDoc in `lua/zync/api/commands/commands.lua` for flash/run args and command metadata; added handler param doc in `lua/zync/api/commands/Command.lua`; clarified log suppression note in `lua/zync/lib/utils.lua`. All docs keep blank-line spacing; no functional changes.
<!-- SECTION:NOTES:END -->
