skill-vale-qdoc-lint

Lint QDoc, QML, and C++ doc-comments with a patched Vale binary.

19|29|Updated May 6, 2013

Search Tags:#documentation #pre-commit #lint #cpp #vale #qdoc #qtqa

One-click install

npx skills add https://github.com/qt/qtqa --skill skill-vale-qdoc-lint

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: skill-vale-qdoc-lint
Source: https://github.com/qt/qtqa/tree/main/documentation_review/skills/skill-vale-qdoc-lint
Command: npx skills add https://github.com/qt/qtqa --skill skill-vale-qdoc-lint

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automate QDoc linting for Qt sources by integrating a patched Vale binary, persistent setup, and a streamlined workflow that reduces manual review overhead.

Core Features & Use Cases

Patched Vale binary to lint QDoc, .qdoc/.qml/.cpp doc-comments
Persisted configuration to ~/.vale-qdoc-agent.json to remember paths and settings
Pre-commit hook installation and integration for staged changes
Annotated diff and grouped report formats to surface issues
qtqa sparse-clone guidance to locate and configure the linter

Quick Start

Run the patched Vale QDoc linter on your Qt QDoc sources to produce a grouped report.

Frequently Asked Questions about skill-vale-qdoc-lint

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

FAQPage Schema

How do I automate QDoc linting for C++ and QML doc-comments in Qt source workflows?▼

To automate QDoc linting for Qt sources, you can use a patched Vale binary integrated into Qt source workflows. It processes .qdoc, .qml, and .cpp doc-comments, reducing manual review overhead during development and review.

What do I need to configure before running Vale QDoc checks on Qt projects?▼

Before running Vale QDoc checks, you need a patched Vale binary, a qtqa clone with vale_linter_config, and environment variables VALE_QDOC_BIN and VALE_CONFIG_PATH set. Configuration is persisted to ~/.vale-qdoc-agent.json.

Can I integrate Vale QDoc linting into a pre-commit hook for staged changes?▼

Yes, you can integrate Vale QDoc linting into a pre-commit hook. The Skill provides pre-commit hook installation and integration to automatically check staged changes in your Qt QDoc sources before commit.

Why is a patched Vale binary required for linting Qt QDoc files instead of standard Vale?▼

A patched Vale binary is required to specifically parse and lint Qt QDoc syntax within .qdoc, .qml, and .cpp files. Standard Vale lacks the specialized parsing rules needed for Qt source workflows and QDoc doc-comments.