# qt-cpp-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.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 782 installs · ★ 507
- Author: qt-ai-skills
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/TheQtCompanyRnD/agent-skills/tree/HEAD/skills/qt-cpp-docs/SKILL.md
- Updated: 2026-10-20
- HTML: https://affpapa.org/en/nevibecode/skills/qt-cpp-docs

## What it 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.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/qt-cpp-docs/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/qt-cpp-docs/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/qt-cpp-docs/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/qt-cpp-docs/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install TheQtCompanyRnD/agent-skills qt-cpp-docs
```

2. **Manually: put the files in place**
- File: `.github/skills/qt-cpp-docs/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/TheQtCompanyRnD/agent-skills --path skills/qt-cpp-docs
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/qt-cpp-docs/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add TheQtCompanyRnD/agent-skills --skill qt-cpp-docs -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/TheQtCompanyRnD/agent-skills/tree/HEAD/skills/qt-cpp-docs/SKILL.md

## When to use it
- 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
- 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`

## Similar
- [docs-write](https://affpapa.org/en/nevibecode/skills/docs-write.md) — skill · 2100 installs
- [write-docs](https://affpapa.org/en/nevibecode/skills/write-docs.md) — skill · 693 installs
- [backend-to-frontend-handoff-docs](https://affpapa.org/en/nevibecode/skills/backend-to-frontend-handoff-docs.md) — skill · 164 installs
- [update-docs](https://affpapa.org/en/nevibecode/commands/update-docs.md) — command · 3861 installs
- [project-docs](https://affpapa.org/en/nevibecode/skills/project-docs.md) — skill · 1200 installs
- [cpp-pro](https://affpapa.org/en/nevibecode/skills/httpsgithubcomjeffallan-cpp-pro.md) — skill · 5300 installs

From the same set: [theqtcompanyrnd/agent-skills](https://affpapa.org/en/nevibecode/by/theqtcompanyrnd/agent-skills.md) — 8 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md