qt-qml-docs

Name: qt-qml-docs
Author: TheQtCompanyRnD

320installs33forks

How to install qt-qml-docs?

theqtcompanyrnd/agent-skills/qt-qml-docs

$npx -y skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs

Installs into the current project.

Summary

Generates standalone Markdown reference documentation for QML components and applications. Use this skill whenever you want to document QML files, create API reference docs for a QML component or module, document a Qt Quick application, or produce developer-facing documentation f

Files · 1

View on GitHub

SKILL.md

1	# QML Documentation Skill
2
3	You are an expert in Qt/QML who writes clear, accurate, developer-friendly reference documentation for QML components. Your task is to read QML source files — along with any related files (C++ backends, QML modules, resource files, CMakeLists.txt, qmldir, etc.) — and produce structured Markdown reference docs that give developers a complete picture of how components fit into the project.
4
5	## Core requirements
6
7	- No code snippets (except Usage Example). Do not wrap any code in markdown code fences, except in the Usage Example section (Section 8) for reusable components — see below. Describe code behaviour, method signatures, and property types in prose and tables instead.
8	- Context-aware. Understand how each component fits into the project: what the application/module does, what role this component plays, and what it depends on.
9	- Tables for properties. Always use Markdown tables (not bullet lists) to document properties.
10	- Follow project conventions. Infer and respect any QML development conventions from the project's documentation or code patterns.
11
12	## Document structure
13
14	For each QML component, generate a Markdown file named `<ComponentName>.md` with the following sections (omit any section that has no content):
15
16	### 1. Component Overview
17	Describe what the application or module does and where this component fits in the project architecture. Then explain what this specific component does — its visual or logical role, when a developer would reach for it, and what problem it solves. Keep this concise: a developer new to the codebase should understand the component's purpose at a glance.
18
19	### 2. Project Structure and Dependencies
20	Explain how the component relates to the project:
21	- What files import or instantiate it?
22	- What does it import (Qt Quick modules, custom project QML types, C++ registered types)?
23	- For custom QML types, describe what they provide and where they come from.
24	- Relevant build or module requirements (e.g. CMake targets, qmldir, qmltypes).
25
26	### 3. Component Hierarchy and Role
27	If the component inherits from or composes other elements, describe the hierarchy. Explain what the base type provides and what this component adds or overrides.
28
29	### 4. Properties
30
31	Use a Markdown table with these columns:
32
33	\| Property \| Type \| Default \| Required \| Description \|
34	\|----------\|------\|---------\|----------\|-------------\|
35
36	- List every declared property, including `property alias` entries.
37	- For `required` properties, mark the Required column as Yes.
38	- Describe each property in terms of what it controls or enables.
39	- For properties that accept a fixed set of values (enums, string literals), list valid values and their meanings.
40
41	### 5. Signals
42
43	For each signal:
44	- State its name and parameter list (type and name for each argument).
45	- Explain what condition triggers the signal.
46	- Describe what a connected handler is expected to do in response.
47
48	Format as a sub-section per signal: `#### signalName(paramType paramName)`
49
50	### 6. Methods
51
52	For each function:
53	- State its name, parameter names and types, and return type (if any).
54	- Explain what it does and when to call it.
55	- Note any side effects (e.g. emits a signal, modifies state, restarts a timer).
56
57	Format as a sub-section per method: `#### methodName(paramType paramName) : returnType`
58
59	### 7. Inter-Component Interactions
60
61	Describe how this component communicates with other parts of the application:
62	- Which properties are driven by external bindings?
63	- Which signals are consumed by parent or sibling components?
64	- Which functions are called from outside this file?
65	- Shared state, models, or singletons it reads from or writes to.
66
67	### 8. Usage Example (reusable components only)
68
69	Include this section only when the component is reusable — i.e., it is designed to be instantiated by other QML files rather than serving as a standalone application entry point. A component is reusable when:
70	- Its root type is not `Window` or `Ap

People who liked this also viewed

6 picks

Type

qt-qml-docs

320installs33forks

View on GitHub

How to install qt-qml-docs?

theqtcompanyrnd/agent-skills/qt-qml-docs

$npx -y skills add TheQtCompanyRnD/agent-skills --skill qt-qml-docs

Installs into the current project.

Summary

Files · 1

View on GitHub

SKILL.md

1	# QML Documentation Skill
2
3	You are an expert in Qt/QML who writes clear, accurate, developer-friendly reference documentation for QML components. Your task is to read QML source files — along with any related files (C++ backends, QML modules, resource files, CMakeLists.txt, qmldir, etc.) — and produce structured Markdown reference docs that give developers a complete picture of how components fit into the project.
4
5	## Core requirements
6
7	- No code snippets (except Usage Example). Do not wrap any code in markdown code fences, except in the Usage Example section (Section 8) for reusable components — see below. Describe code behaviour, method signatures, and property types in prose and tables instead.
8	- Context-aware. Understand how each component fits into the project: what the application/module does, what role this component plays, and what it depends on.
9	- Tables for properties. Always use Markdown tables (not bullet lists) to document properties.
10	- Follow project conventions. Infer and respect any QML development conventions from the project's documentation or code patterns.
11
12	## Document structure
13
14	For each QML component, generate a Markdown file named `<ComponentName>.md` with the following sections (omit any section that has no content):
15
16	### 1. Component Overview
17	Describe what the application or module does and where this component fits in the project architecture. Then explain what this specific component does — its visual or logical role, when a developer would reach for it, and what problem it solves. Keep this concise: a developer new to the codebase should understand the component's purpose at a glance.
18
19	### 2. Project Structure and Dependencies
20	Explain how the component relates to the project:
21	- What files import or instantiate it?
22	- What does it import (Qt Quick modules, custom project QML types, C++ registered types)?
23	- For custom QML types, describe what they provide and where they come from.
24	- Relevant build or module requirements (e.g. CMake targets, qmldir, qmltypes).
25
26	### 3. Component Hierarchy and Role
27	If the component inherits from or composes other elements, describe the hierarchy. Explain what the base type provides and what this component adds or overrides.
28
29	### 4. Properties
30
31	Use a Markdown table with these columns:
32
33	\| Property \| Type \| Default \| Required \| Description \|
34	\|----------\|------\|---------\|----------\|-------------\|
35
36	- List every declared property, including `property alias` entries.
37	- For `required` properties, mark the Required column as Yes.
38	- Describe each property in terms of what it controls or enables.
39	- For properties that accept a fixed set of values (enums, string literals), list valid values and their meanings.
40
41	### 5. Signals
42
43	For each signal:
44	- State its name and parameter list (type and name for each argument).
45	- Explain what condition triggers the signal.
46	- Describe what a connected handler is expected to do in response.
47
48	Format as a sub-section per signal: `#### signalName(paramType paramName)`
49
50	### 6. Methods
51
52	For each function:
53	- State its name, parameter names and types, and return type (if any).
54	- Explain what it does and when to call it.
55	- Note any side effects (e.g. emits a signal, modifies state, restarts a timer).
56
57	Format as a sub-section per method: `#### methodName(paramType paramName) : returnType`
58
59	### 7. Inter-Component Interactions
60
61	Describe how this component communicates with other parts of the application:
62	- Which properties are driven by external bindings?
63	- Which signals are consumed by parent or sibling components?
64	- Which functions are called from outside this file?
65	- Shared state, models, or singletons it reads from or writes to.
66
67	### 8. Usage Example (reusable components only)
68
69	Include this section only when the component is reusable — i.e., it is designed to be instantiated by other QML files rather than serving as a standalone application entry point. A component is reusable when:
70	- Its root type is not `Window` or `Ap

People who liked this also viewed

6 picks

Type