qt-qml-docs — Claude Code skill: QML reference docs

What qt-qml-docs does

This skill produces reference documentation for QML components and Qt Quick applications. The agent goes through the sources — the .qml files themselves plus C++ backends, modules, qmldir, CMakeLists.txt — and writes one <ComponentName>.md per component. The structure is fixed: component overview, its place in the project and its dependencies, type hierarchy, a properties table with Property, Type, Default, Required and Description columns, then signals and methods as separate subsections, then how the component talks to the rest of the app.

Properties always come as a table, never a bullet list. Code fences are avoided everywhere except the Usage Example section, and that section appears only for reusable components whose root type is not Window or ApplicationWindow. Each signal gets a note on what triggers it and what the connected handler should do; each method gets its parameters, return type and side effects such as restarting a timer.

Before reading any source, the skill checks whether docs already exist in a doc/ directory next to the code. If they do, the agent stops and asks whether to update the existing files, skip them, regenerate everything or cancel. That matters when you touch one component in a larger project — you avoid silently overwriting docs for its neighbours. QDoc output is out of scope; you need a different tool for that.