fix(docs): suppress Doxygen auto-linking of text in jsonb selector @warning

[coderdan]

Fixes #384

Problem

Doxygen auto-links the bare word text (it collides with a documented symbol) into a cross-reference inside inline code in the jsonb selector operator's @warning:

<computeroutput>col -&gt; &apos;sel&apos;<ref refid="lints_8sql_...">text</ref></computeroutput>

A <ref> nested in <computeroutput> renders to an unbalanced <tt> in API.md, which broke the cipherstash/docs MDX build on eql-3.0.0-alpha.3 (index.mdx:2153: Expected a closing tag for <tt>). The :: was dropped too, so the cast read 'sel'text.

Fix

Prefix the two text occurrences with Doxygen's % no-autolink marker (::%text, -> %text) in src/v3/jsonb/operators.sql. The % is consumed by Doxygen (not rendered).

Verification

Ran doxygen on the changed source:

• The nested <ref> is gone.
• col -> 'sel'::text renders as clean, balanced inline code (the :: is preserved).

Note: my local doxygen is 1.15.0, which masks the <tt> symptom; please confirm against the CI doxygen version. The fix removes the version-independent trigger (the nested <ref>), so it resolves the break on any version.

Related

• Downstream safety net: fix(eql-docs): strip Doxygen <tt> tags so a stray one can't break the build docs#52 (defensively strips <tt> in the docs generator).
• Alternative root fix discussed in the issue: AUTOLINK_SUPPORT = NO in the Doxyfile.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 03dea8d1-98b8-4b61-8e13-b10e58f87125

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/jsonb-warning-doxygen-autolink

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}