# qt-cpp-docs

> Claude/Codex skill by [@theqtcompanyrnd](https://omgskills.com/library/theqtcompanyrnd/index.md) · 498 stars · Updated 2026-10-20

Generates standalone Markdown reference documentation for any Qt/C++ source files — Qt Widgets classes, Qt Quick backends, Qt/C++ modules, plain C++ utilities, structs, free-function headers, and entry points like main.cpp. Use this skill to document any .h or .cpp file: Qt classes, plain C++ code, utility helpers, or application startup files. Triggers on: "document this class", "write docs for my C++", "document main.cpp", "C++ API docs", "document my Qt app", or whenever C++ or header files are provided and documentation is needed. Works with single files, pasted code, or entire project folders. DO NOT use if the user asks for QDoc format output.

Tags: ai-skills, claude-code, codex, github-copilot, qml, qt

## Install

```sh
git clone https://github.com/TheQtCompanyRnD/agent-skills /tmp/agent-skills && ln -s /tmp/agent-skills/skills/qt-cpp-docs ~/.claude/skills/qt-cpp-docs
```

## From README

Qt C++ Documentation Skill You are an expert in Qt/C++ who writes clear, accurate, developer-friendly reference documentation for any C++ source file in a Qt project. Your task is to read C++ header and source files — along with any related files (other headers, CMakeLists.txt, .ui files, .qrc files, qmldir, etc.) — and produce structured Markdown reference docs that give developers a complete picture of how each file or class fits into the project. This skill covers the full spectrum of C++ files you might encounter in a Qt project: Qt classes with QOBJECT, signals/slots, properties (Widgets, Quick, models, etc.) Plain C++ classes and structs with no Qt macros Free-function headers (utility APIs, algorithm collections, helper namespaces) Application entry points (main.cpp) — documenting startup sequence, Qt application , command-line handling, and top-level object wiring Choose the document structure below that matches the file you are documenting.

## Links

- HTML page: https://omgskills.com/library/theqtcompanyrnd/agent-skills/skills/qt-cpp-docs/
- GitHub: https://github.com/TheQtCompanyRnD/agent-skills
- Author: [@theqtcompanyrnd](https://omgskills.com/library/theqtcompanyrnd/index.md)

## More from this repo

- [qt-canvas2d](https://omgskills.com/library/theqtcompanyrnd/agent-skills/skills/qt-canvas2d/index.md) — Applies Qt Canvas2D (QtCanvas2D / Qt Canvas Painter, Qt 6.12+) best practices when producing or working with Canvas2D...
   - [@theqtcompanyrnd](https://omgskills.com/library/theqtcompanyrnd/index.md) · 498 stars
- [qt-cmake-project](https://omgskills.com/library/theqtcompanyrnd/agent-skills/skills/qt-cmake-project/index.md) — Use to generate or update Qt 6 CMake projects or edit CMakeLists.txt, add sources/resources or define targets...
   - [@theqtcompanyrnd](https://omgskills.com/library/theqtcompanyrnd/index.md) · 498 stars
- [qt-cpp-review](https://omgskills.com/library/theqtcompanyrnd/agent-skills/skills/qt-cpp-review/index.md) — Invoke when the user asks to review, check, audit, or look over Qt6 C++ code — or suggest before committing.
   - [@theqtcompanyrnd](https://omgskills.com/library/theqtcompanyrnd/index.md) · 498 stars
