qt-cpp-docs — Claude Code skill: Qt/C++ reference docs
This skill reads your C++ headers and sources in a Qt project and writes standalone Markdown reference pages from them. Handy when an API needs documenting instead of hand-written notes.
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a claude-codeWhat qt-cpp-docs does
The skill takes .h and .cpp files along with related ones — other headers, CMakeLists.txt, .ui, .qrc, qmldir — and turns them into a reference document. Classes with Q_OBJECT, signals and slots, properties, plain structs without Qt macros, free-function headers, and entry points such as main.cpp each get their own section layout.
Inside there is a fixed outline: class overview and its place in the project, dependencies and Qt modules, inheritance chain, tables for Q_PROPERTY and Q_ENUM, public members, and a separate section for protected API. Private members are skipped unless they surface through Q_PROPERTY or Q_INVOKABLE. The header counts as the source of truth; the .cpp supplies behaviour and side effects.
One hard rule on format: code fences are banned everywhere except the usage example section. Method signatures and property types go into prose and tables. If you need QDoc output, look elsewhere — this skill does not produce it.
What it helps with
- document a Qt class with its signals and properties
- write up
main.cppand the startup sequence - describe a free-function header with no classes
- lay out
Q_PROPERTYandQ_ENUMas tables - trace a class's dependencies from
#includeandCMakeLists.txt
Example prompts for the agent
- document the
FileWatcherclass infilewatcher.h - write reference docs for this project's
main.cpp - generate Markdown docs for every header under
src/utils
How to install qt-cpp-docs
1Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a claude-code2Manually: put the files in place
~/.claude/skills/qt-cpp-docs/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/qt-cpp-docs/
1Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a codex2Manually: put the files in place
.agents/skills/qt-cpp-docs/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a cursor2Manually: put the files in place
.cursor/skills/qt-cpp-docs/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install TheQtCompanyRnD/agent-skills qt-cpp-docs2Manually: put the files in place
.github/skills/qt-cpp-docs/SKILL.md1Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a gemini-cli2Platform CLI
gemini skills install https://github.com/TheQtCompanyRnD/agent-skills --path skills/qt-cpp-docsManually: put the files in place
.devin/skills/qt-cpp-docs/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about qt-cpp-docs
How do I install qt-cpp-docs in Claude?
Run npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a claude-code. The skill lands at ~/.claude/skills/qt-cpp-docs/SKILL.md.
What does qt-cpp-docs do?
It reads C++ and Qt files in a project and produces separate Markdown documents with a section layout matched to each file.
Can it output QDoc format?
No. The skill writes Markdown, and QDoc output is out of scope.