skill-vale-qdoc

Route QDoc-annotated C++ and QML files through Vale linting with scopes and code block exclusions.

19|29|Updated May 6, 2013

Search Tags:#parser #lint #scopes #vale #qdoc #extension-routing

One-click install

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

Or copy as Structured Prompt for Agent▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Vale QDoc parsing and linting capabilities for a patched Vale build with QDoc support, including file routing, scopes, and caveats to ensure consistent QDoc checks.

Core Features & Use Cases

File routing: route extensions to the QDoc linting pipeline and enable selective C++/QML linting.
Scope mapping: provide text.comment.* and meta.* scopes to guide lint rules and prevent image/anchor issues.
Code block handling: exclude code blocks from linting to preserve accurate prose checks.
Configuration guidance: describe enabling formats and caveats described in the guide for stable operation.
Use Case: lint a repository with QDoc blocks across C++/QML sources while excluding code blocks.

Quick Start

Run the patched Vale QDoc configuration on your codebase to lint QDoc blocks.

Frequently Asked Questions about skill-vale-qdoc

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

FAQPage Schema

How do I lint QDoc comments in C++ and QML source files?▼

To lint QDoc comments, route C++ and QML file extensions through a patched Vale configuration that applies QDoc-specific scopes and skips non-QDoc code blocks.

Can I use Vale to check prose inside QDoc-annotated source code?▼

Yes, Vale can check prose in QDoc-annotated source code by applying extension-based routing to map QDoc blocks to text.comment.* and meta.* scopes for accurate lint rules.

How does extension-based routing work for QDoc linting?▼

Extension-based routing directs C++ and QML files into the QDoc linting pipeline, selectively applying scopes and caveats to ensure consistent prose checks across different source extensions.

Does Vale exclude code blocks when linting QDoc documentation?▼

Yes, Vale excludes code blocks from linting to preserve accurate prose checks. This skip logic prevents false positives caused by syntax inside QDoc code snippets.

What scopes does Vale apply when parsing QDoc comments?▼

Vale applies text.comment.* and meta.* scopes when parsing QDoc comments. These scopes guide lint rules and prevent image and anchor issues within the documentation.

What are the limitations of linting QDoc with a patched Vale build?▼

Limitations include requiring a patched Vale build with QDoc support and adhering to specific configuration caveats for stable operation across mixed C++ and QML codebases.