Documentation coverage

C. Klukas · 2026-08-09

This matrix is deliberately checked by doc_widget_coverage. It maps every public widget header to the client guide, a real example, generated screenshot, and executable test family. Screenshots are generated, not committed artwork.

Most Screenshot entries now name a widget-* figure: a focused cut-out of the widget, written by tools/docgen/capture_widget_shots from a scene in tools/docgen/widget_shots_*.cpp. Those scenes are compiled examples in their own right — the widget gallery quotes each one as that widget's usage sample — which is why they appear in the Compiled example column as widget_shots.

Interaction scripts

Every public view type is also driven by at least one Application-level interaction script, and interaction_script_coverage checks this table against the tests (tools/docgen/check_interaction_scripts.py, with a --self-test). A script is a CK_TEST that reaches the view in a real Application and sends it input the way a terminal does: through Application::dispatch, HeadlessTerminal::inject_event or Application::step. The gate requires, for each row:

• the view type is one the documentation-coverage gate enumerates, and every such type has a row;
• the named case exists in the named file under tests/;
• the case calls dispatch, inject_event or step, directly or through a helper the same test file defines;
• the case never calls a view's on_key, on_key_release, on_mouse, on_text or on_paste handler itself, directly or through such a helper;
• the case names the "Reached through" identifier: the type itself, or the factory, example or fixture that builds it.