2012-04-20 8 views
15

Mam "książkę projektu", która używa LaTeX-a \documentclass{report} ("raport" jest jak bardziej kompaktowa wersja \documentclass{book}). Chciałbym dołączyć do tej książki dodatek z wygenerowaną przez DoXygen dokumentacją API dla oprogramowania w projekcie.W tym dane wyjściowe LaTeX doksygena jako załącznik do większego dokumentu

Osiągnąłem to, ustawiając opcje konfiguracyjne Doxygen's LATEX_HEADER i LATEX_FOOTER na pusty plik. To sprawia, że ​​uzyskany lateks/refman.tex mieć poleceń najwyższego poziomu, takich jak: \section{\-Namespace \-Index}, w którym momencie mogę owinąć to z dokumentem najwyższego poziomu, takich jak:

\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} 

Działa to dość dobrze i mam doxygen.sty z tej specjalnej doxygen inwokacja:

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

Jednym z problemów jest to, że kładzie „wygenerowaną automatycznie” nagłówek na całego dokumentu (a nie tylko na dodatku doxygen). Mogę się tego pozbyć, edytując doxygen.sty (zmieniam również nazwę dla mojego włączenia) i komentując blok zaczynający się od % Setup fancy headings.

W tym momencie mam coś, z czym mogę żyć, ale chciałbym pójść o krok dalej: styl "doxygen" modyfikuje wiele innych aspektów stylu dokumentu LaTeX, a ja lubię go mniej.

Więc moje pytanie brzmi (w dwóch poziomach doskonałości):

  1. Jaki byłby minimalny zestaw poleceń LaTeX, aby umieścić w pliku doxygen.sty że ładnie wykonywali dodatek doxygen ale nie przeszkadzają z resztą dokumentu LaTeX?

  2. Jeszcze lepiej, ma ktoś wymyślić sposób robienia

    \usepackage{doxygen_standalone} 
    % [... until you need doxygen] 
    \begin{doxygen} 
    % the stuff you need to insert your auto-generated doxygen API docs, 
    % for example the \subimport{latex/}{refman.tex} that I showed above 
    \end{doxygen} 
    

To ostatnie podejście jest jednym uznałbym bardzo czyste.

Mam nadzieję, że istnieje naprawdę prosta odpowiedź, na przykład "to już istnieje w doxygen.sty jako opcja, a przegapiłeś!"

+2

Mam to samo pytanie. Czy ktoś może komentować? Zobacz także mój post na [SO here] (http://stackoverflow.com/questions/12219578/individual-function-docs-in-latex-using-doxygen). – garyp

+1

Dołączyłem skompresowany doxygen PDF z lateksem za pomocą pakietu pdfpages. – Anna

+0

To naprawdę nie jest bliskie właściwej odpowiedzi, ale jednym ze sposobów może być wskazanie, które polecenia chcesz odwrócić i użyć \ renewcommand lub \ forgetcommand, aby je usunąć. Wyobrażam sobie, że prawdopodobnie użyjesz \ includeonly do wybiórczego zdobycia tego, czego chcesz, bez poleceń. –

Odpowiedz

1

rename doxygen.sty do mydoxygen.sty, a następnie modyfikować poprzez wstawienie \ newenvironment {{...} doxygen większość doxygen.sty idzie tutaj ...} {}

Powiązane problemy