Как включить фрагменты LaTeX непосредственно в комментарии Doxygen?

Question

Я хотел бы иметь возможность редактировать части LaTeX некоторых комментариев Doxygen с помощью подходящего редактора.Я бы использовал это только для сложных сред.Для этого я решил, что могу иметь файлы только для LaTeX и включать их из Doxygen.Я создал псевдонимы Doxygen для \begin и \end, чтобы сделать синтаксис совместимым.

(Например, я знаю, как настроить Emacs / AUCTex для работы с фрагментами LaTeX без преамбулы и документаструктура.)

Есть ли способ включить содержимое файла .tex в комментарий Doxygen?Я ищу что-то аналогичное \htmlinclude, но для файлов TeX.Есть ли способ эмулировать функциональность, учитывая мои требования к наличию внешнего источника только для TeX?

Answer 1

Вы можете использовать что-то вроде

\latexonly
\input <file>
\endlatexonly

где <file> - это путь к файлу, который нужно включить, либо абсолютный, либо относительно каталога, в котором создается латексная документация.

Answer 2

Вы пробовали команду \verbinclude? Эта команда включает любой дословный файл в документацию (в отличие от \include, который используется для включения исходных файлов).

Из руководства по доксигену:

\verbinclude <file-name>

Эта команда включает файл <file-name> дословно в документацию. Команда эквивалентна вставке файла в документацию и помещению команд \verbatim и \endverbatim вокруг него.

Файлы или каталоги, которые должен искать doxygen, можно указать с помощью тега EXAMPLE_PATH файла конфигурации doxygen.

Редактировать : Я только подумал, что вы можете удалить преамбулу из вашего файла .tex, прежде чем включать остальную часть файла в документацию. Вы можете сделать это с помощью команды \dontinclude, которая вместе с командами \line, \skip, \skipline и \until позволяет вам включать определенные строки / блоки определенного файла. См. Пример в \dontinclude документации .