qt-cpp-docs

Generates structured Markdown reference documentation for Qt and C++ source files.

1|Updated Jul 12, 2026
One-click install
npx skills add https://github.com/TypeThe0ry/Multi-Detect --skill qt-cpp-docs-typethe0ry
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: qt-cpp-docs
Source: https://github.com/TypeThe0ry/Multi-Detect/tree/main/ground-control/MultiDetectGCS/tools/skills/qt-cpp-docs
Command: npx skills add https://github.com/TypeThe0ry/Multi-Detect --skill qt-cpp-docs-typethe0ry

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Writing and maintaining reference documentation for Qt/C++ codebases is time-consuming, and developers often skip documenting classes, signals, slots, and properties. This Skill reads your .h and .cpp files and produces complete, structured Markdown reference docs automatically. ## Core Features & Use Cases - Qt Class Documentation: Documents Q_OBJECT classes with Q_PROPERTY tables, signals, slots, Q_INVOKABLE methods, enums, ownership, and thread safety. - Multiple File Types: Handles plain C++ classes and structs, free-function utility headers, and application entry points like main.cpp with tailored document structures. - Folder-Wide Documentation: Walks entire project directories, documents every meaningful header and source file, and generates an index.md linking them all. - Use Case: Point the Skill at a Qt Widgets module folder to produce a doc/ directory containing one Markdown file per class plus a linked index, ready for your project wiki or repository. ## Quick Start Ask the AI to document a Qt C++ class or folder, for example: generate reference documentation for all source files in my src directory.

Frequently Asked Questions about qt-cpp-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate documentation for Qt C++ classes?▼

Provide the .h and .cpp files to the Skill, which reads the header as the API source of truth and the implementation for behavioral context. It outputs a Markdown file per class covering properties, signals, slots, methods, ownership, and thread safety.

What tool documents Qt signals slots and Q_PROPERTY declarations?▼

This Skill parses Q_PROPERTY, Q_ENUM, Q_FLAG, signals, public slots, and Q_INVOKABLE methods and renders them as Markdown tables and method sub-sections. It also documents inheritance, QML exposure, and inter-class interactions.

Can I document an entire Qt project folder at once?▼

Yes, the Skill walks the directory tree and documents every meaningful .h and .cpp file, including main.cpp and utility headers. When documenting more than one file it also creates a doc/index.md linking all generated pages.

Does this generate QDoc format output?▼

No, the Skill explicitly does not produce QDoc format. It generates standalone Markdown reference files written to a doc/ subdirectory next to the source files, suitable for wikis and repository browsing.

What happens if documentation already exists for my files?▼

Before reading sources, the Skill checks the expected doc/ output location. If docs exist, it asks whether to update them, skip documented files, regenerate everything, or cancel, then honors your choice.