A custom WordTemplate including a space

[veshivas]

I wonder if any of you explored customizing the WordTemplate config option. I am using vale to lint comment blocks in C++ source files. These comments use qdoc markup to document the APIs, so I want vale to ignore word or string that has a qdoc command prefix. For example:

Call \c funtionA() to start the process

Where, functionA is prefixed with this qdoc markup to highlight parts of the code, such as variable or function names.

[jdkato]

What I'd do in this case is assign an embedded markup syntax to the comments:

[formats]
# Treat .cc comments as Markdown
cc = md

[*.cc]
# You then have access to all Markup-related features,
# such as TokenIgnores and BlockIgnores.
TokenIgnores = (\\c \w+)

I'm not familiar enough with qdoc markup to know if there's any significant syntax incompatibilities with Markdown, but it doesn't seem like it.

It's also possible that qdoc support could be added natively to Vale. Is there a command-line toolchain for converting qdoc to HTML?

[veshivas]

Yes, there is a command-line tool to parse the qdoc comment blocks, which begin with "/*!" and end with "*/", and the syntax is more closer to LaTex than Markdown. These blocks could appear in different type of files such as, source files (.cpp, .js, and .qml), qdoc files (can only used one or more comment blocks), and qdocinc files (contains random text without the delimiters to enable content reuse). You can find more info. about qdoc here: https://doc.qt.io/qt-6/01-qdoc-manual.html

[veshivas]

Associating the qdoc format to Markdown works for a simple usecase that I tested. Need bit more testing before we conclude anything. But support for qdoc markup would definitely be a welcome change.

[veshivas]

I have logged a feature request to support qdoc markup. #784