Ansel 0.0
A darktable fork - bloat + design vision
Loading...
Searching...
No Matches
doxygen Namespace Reference

-math-filter More...

Detailed Description

-math-filter

Doxygen input filter : Markdown dollar-math -> Doxygen native math.

Converts `$...$` (inline) and `$$...$$` (display) LaTeX equations into
Doxygen's `\\f$...\\f$` and `\\f[...\\f]` commands, so that:

  1. formula bodies are protected from Doxygen's Markdown pass (a raw `$c_{mix}$`
     would have its underscore parsed as emphasis and reach MathJax broken);
  2. rendering goes through the stock Doxygen + MathJax machinery
     (USE_MATHJAX = YES in doc/Doxyfile), no client-side delimiter hacks.

This mirrors the convention of the user documentation (Hugo + MathJax), so the
same equation markup works in both doc trees. Applied to *.md files only, via
FILTER_PATTERNS in doc/Doxyfile — C/C++ comments keep using \\f$ natively
(and their `$MIN/$MAX/$DEFAULT` introspection tokens are never touched).

Rules, matching the usual Markdown-math conventions:
  - `$$...$$` may span several lines; `$...$` must stay on one line;
  - the opening `$` must be immediately followed by a non-space, the closing
    `$` immediately preceded by one (so "5$ and 10$" or "$5 vs $10" are left
    alone);
  - `\\$` is an escaped, literal dollar;
  - fenced code blocks (``` / ~~~) and inline code spans (`...`) are never
    converted.