Skip to main content
skill CX Codex

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.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a claude-code
Open on GitHub

What 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.cpp and the startup sequence
  • describe a free-function header with no classes
  • lay out Q_PROPERTY and Q_ENUM as tables
  • trace a class's dependencies from #include and CMakeLists.txt

Example prompts for the agent

  • document the FileWatcher class in filewatcher.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-code

2Manually: put the files in place

~/.claude/skills/qt-cpp-docs/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/qt-cpp-docs/

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.

Similar skills

Everything for Writing and docs →

From the same set8

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor