refman.rtf не может использовать уравнение из * .md в doxygen - PullRequest
0 голосов
/ 04 июня 2018

Я использую ' .md' для генерации '(индекс ). Html' и '(refman *). Rtf' документацию с doxygen 1.8.14.

Математическое уравнение в «* .md» дает правильное уравнение в выводе html, но не в файле «refman.rtf».Другие теоретические части, такие как параграф и другие, хорошо работают между выводами * .md и rtf.

Я думаю, * .rtf не распознает часть уравнения документа * .md.

Генерирует ли RTF через doxygen файлы * .md?

Нужно ли менять какой-либо тег, чтобы * .md работал с выводом rtf?

1 Ответ

0 голосов
/ 04 июня 2018

Не только для уценки, но и для «нормальных» формул ввода кислорода не работают.

Из документации:

Doxygen позволяет помещать формулы LATEX в вывод (это работает только для выходных данных HTML и LATEX, но не для RTF и не для вывода справочной страницы).

В настоящее время обходной рабочий процесс для не встроенных формул заключается в следующем:

  • Создайте изображение с формулой, например, в фиктивном прогоне кислорода, в котором не используется MATHJAX, это приведет к изображению с именем, например: 'form_0.png'.

В коде нужно поместить конструкцию if, например:

\if rtf_run
  \image rtf form_0.png
\else
  \f... with the formula
\endif

Теперь нужно дважды запустить doxygen:

  • один раз для вывода без rtf, т. Е. Без настройки rtf_run в ENABLED_SECTIONS
  • один раз для rtf вывод при настройке rtf_run в ENABLED_SECTIONS

РЕДАКТИРОВАТЬ Июнь5, 2018: я только что отправил предложенный патч в github pull request 756 .Здесь формулы отображаются в виде png изображений и включены в документацию RTF.

РЕДАКТИРОВАТЬ: 2018/06/10: push-запрос был интегрирован в основную версию на github.

...