Включая вывод doxygen LaTeX в качестве приложения к более крупному документу.

У меня есть "проектная книга", в которой используется LaTeX's \documentclass{report}("отчет" похож на более компактный версия \documentclass{book}). Я хотел бы включить в эту книгу приложение с документацией API, сгенерированной Doxygen, для программного обеспечения в проекте.

Я добился этого, установив параметры конфигурации Doxygen LATEX_HEADERи LATEX_FOOTERв пустой файл. Это приводит к тому, что полученный латекс/refman.tex имеет команды верхнего уровня, такие как: \section{\-Namespace \-Index}, после чего я могу обернуть это документом верхнего уровня, например:

\documentclass{report}
\usepackage{doxygen.sty}
% the "import" package helps to find Doxygen files in the latex/ subdirectory
\usepackage{import}
% [...] title page and the rest of the book

\appendix
\chapter{API reference (generated by Doxygen)
subimport{latex/}{refman.tex}

% [...] final stuff
\end{document}

Это работает довольно хорошо, и я получаю doxygen.styс помощью этого специального вызова doxygen:

doxygen -w latex /dev/null /dev/null doxygen.sty

Одна проблема заключается в том, что это помещает "автогенерируемый" заголовок во весь документ (а не только в приложение doxygen). Я могу избавиться от этого, отредактировав doxygen.sty(на самом деле, я также переименовал его для своего включения) и закомментировав блок, который начинается с % Setup fancy headers.

На данный момент у меня есть кое-что, с чем я могу жить, но я хотел бы сделать еще один шаг: стиль «doxygen» изменяет множество других аспектов стиля документа LaTeX, и он мне нравится меньше.

Итак, мой вопрос (в двух уровнях совершенства):

  1. Каков будет минимальный набор команд LaTeX для помещения в файл doxygen.sty, который будет хорошо отображать приложение doxygen, но не будет мешать остальной части Документ LaTeX?

  2. Еще лучше, кто-то придумал, как это сделать

    \usepackage{doxygen_standalone}
    % [... пока вам не понадобится doxygen]
    \begin{доксиген}
    % материал, который вам нужен для вставки ваших автоматически сгенерированных документов API doxygen,
    % например, \subimport{latex/}{refman.tex}, который я показал выше
    \end{doxygen}
    

Последний подход я считаю очень чистым.

Я надеюсь, что есть действительно простой ответ, например, "это уже есть в doxygen.sty в качестве опции, и вы это пропустили!"

16
задан Chris 20 April 2012 в 08:18
поделиться