skill-qdoc-output

Generate HTML filenames for QDoc documentation node types using documented patterns.

19|29|Updated May 6, 2013

Search Tags:#documentation #html #filenames #naming-patterns #node-type #qdoc

One-click install

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

Or copy as Structured Prompt for Agent▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

QDoc HTML filename generation patterns are essential for consistent, predictable HTML output across documentation node types, enabling reliable linking and indexing.

Core Features & Use Cases

Provides explicit filename patterns by node type (C++ class, C++ module, QML type, QML module, group, example, page).
Describes the algorithmic rules used by QDoc to assemble filenames and verify them via index files.
References the primary implementation location for implementation details and integration notes.

Quick Start

Provide the correct HTML filename for each QDoc node type using the published naming rules.

Frequently Asked Questions about skill-qdoc-output

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

FAQPage Schema

How does QDoc generate HTML filenames for different documentation node types?▼

QDoc generates HTML filenames by applying specific prefixes, suffixes, and canonicalization rules to documentation node types like C++ classes, QML types, and modules to ensure consistent linking and predictable index files.

What are the QDoc HTML filename naming patterns for QML types and C++ modules?▼

QDoc HTML filename naming patterns for QML types and C++ modules involve algorithmic assembly using designated prefixes and suffixes, canonicalizing the node names to produce predictable output files for reliable documentation indexing.

How do I determine the correct HTML filename for a QDoc C++ class or group page?▼

To determine the correct HTML filename for a QDoc C++ class or group page, apply the published QDoc naming rules which map specific node types to their corresponding filename patterns and canonicalization formats.

Why do QDoc generated HTML filenames not match my documentation node names?▼

QDoc generated HTML filenames may not match node names directly because QDoc applies canonicalization, prefixes, and suffixes based on the specific node type, altering the original name to conform to its HTML output generation patterns.

Can I predict QDoc HTML output filenames for custom documentation pages and examples?▼

You can predict QDoc HTML output filenames for custom documentation pages and examples by referencing the primary generator functions and applying the documented naming pattern rules specific to those node types.

When do I need to verify QDoc HTML filenames against documentation index files?▼

You need to verify QDoc HTML filenames against documentation index files when validating reliable linking and consistent output, ensuring the generated patterns for C++ classes, QML types, and modules conform to the algorithmic rules.