François
043fef0a31
- `essim --commands-md [file]` instantiates the Tui, calls
`Tui::DumpCommandsMd(ostream&)` which iterates the live registry and
emits Markdown grouped by interactive/other, then exits. Single
source of truth: a new `CommandSpec` field surfaces automatically.
- CMake `doc` target now `DEPENDS essim` and chains:
doxygen → gen_api_md.py → doc/api/
essim --commands-md → doc/user/commands.md
- `doc/user/` adds:
- index.md (hand-written) — first session, interactive-screen
conventions, save/restore/replay overview.
- scripting.md (hand-written) — `set`/`$var` expansion semantics,
`source` event-paced execution, script-save denylist, worked
example pointing at test/system.essim.
- commands.md (auto-generated, regenerated by the `doc` target).
- Top-level README refocused on quick start; pointers to the new
doc tree (user/, api/, DESIGN.md) instead of an inline command table.
- doc/README.md and DESIGN.md document the two-pipeline doc workflow.
- `test/system.essim` and user docs anonymised: bkp → backplane,
vdn1/2/3 → payload1/2/3, cb3p → payload4, bpb/cob/ssu →
peripheral1/2/3; netlist file names + variable names + paths all
replaced with generic equivalents.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
38 lines
756 B
Markdown
38 lines
756 B
Markdown
# Tui::CommandSpec
|
|
|
|
`struct Tui::CommandSpec`
|
|
|
|
Defined in [tui.hpp:27](../../../../src/tui/tui.hpp#L27)
|
|
|
|
## Public Attributes
|
|
|
|
### `std::vector< Param > params`
|
|
|
|
📍 [tui.hpp:32](../../../../src/tui/tui.hpp#L32)
|
|
|
|
### `std::function< void(const std::vector< std::string > &)> action`
|
|
|
|
📍 [tui.hpp:33](../../../../src/tui/tui.hpp#L33)
|
|
|
|
### `bool prompt_for_missing`
|
|
|
|
📍 [tui.hpp:34](../../../../src/tui/tui.hpp#L34)
|
|
|
|
### `std::string description`
|
|
|
|
📍 [tui.hpp:35](../../../../src/tui/tui.hpp#L35)
|
|
|
|
### `bool scriptable`
|
|
|
|
📍 [tui.hpp:36](../../../../src/tui/tui.hpp#L36)
|
|
|
|
### `bool interactive`
|
|
|
|
📍 [tui.hpp:37](../../../../src/tui/tui.hpp#L37)
|
|
|
|
opens a full-screen mode when called bare
|
|
|
|
---
|
|
|
|
← [Back to classes](index.md) · [Top](../index.md)
|