Я использую Doxygen для генерации документации для моего кода. Я должен сделать версию PDF из этого, и ЛАТЕКСНЫЙ вывод Doxygen использования, кажется, способ сделать это.
Однако я столкнулся со многими раздражающими проблемами и не знанием, что что-либо о ЛАТЕКСЕ ранее действительно не надело большую часть идеи, как приблизиться к ним, и бесчисленные ссылки для связанных с латексом вещей не являются большим количеством справки...
Я разработал, как создать вещь пользовательского стиля в файле свинарника и как заставить Doxygen использовать его. После большого поиска я узнал, как установить поля страницы и т.д. через это, и я предполагаю, возможно, это - файл, который я хочу для того, чтобы сделать другие вещи, которые я хочу, но я, может казаться, не нахожу команд для того, чтобы сделать то, что я хочу :(
Оглавление в начале документа содержит много идентификатора объектов скорее, это не сделало, поскольку это делает содержание очень долго. Там некоторый путь состоит в том, чтобы ограничить это содержание, чтобы просто сказать первые два уровня, вместо того, чтобы иметь записи для каждой отдельной функции, переменной, и т.д.? Идентификатору вполне нравится сохранять все закладки как бы то ни было. Я действительно пробовал опцию "COMPACT_LATEX", но а также объекты удаления на страницах содержания, она удалила закладки и списки элементов в начале каждого раздела, который я действительно хочу сохранить.
Существует ли способ изменить порядок вещей, как помещение полного описания класса в начале раздела, а не после всех участников и атрибутов?
Вау, это вид зла Doxygen.
Хорошо, чтобы обойти проблему счетчика tocdepth
, добавьте следующую строку в свой файл .sty
:
\AtBeginDocument{\setcounter{tocdepth}{2}}% or whatever level you want
Вы можете установить для глубины закладок PDF отдельное значение:
% requires you \usepackage{hyperref} first
\hypersetup{
bookmarksdepth = section, % of whatever level you want
}
Также обратите внимание, что если у вас есть список рисунков / таблиц, то tocdepth
должно быть не менее 2, чтобы они отображались.
Я не вижу способа переставить эти элементы в файлах LaTeX - Doxygen просто блокирует их, так что мы мало что можем сделать. Вам придется покопаться в документации Doxygen, чтобы увидеть, есть ли способ указать порядок, который я предполагаю. (Надеюсь!)
Вы можете написать сценарий Perl / Awk, чтобы просто удалить ненужные строки из оглавления. Для файла burble.tex
Latex сгенерирует файл burble.toc
, который будет содержать такие строки, как:
\contentsline {subsection}{Class F rewrites}{38} \contentsline {subsection}{Class M rewrites}{39} \contentsline {section}{\numberline {7}Definition and properties of the translation}{44} \contentsline {paragraph}{Well-formedness}{54}
Простые регулярные выражения будут определять, к каким уровням принадлежит каждая строка, и вы можете отфильтровать файл на основе этого. Когда у вас есть оглавление в том виде, в каком вы хотите, вставьте \ nofiles
в соответствующее место (таблица стилей?), Это означает, что Latex будет читать вспомогательные файлы, но не перезаписывать их.
Вы , так что близко.
Поиск в Google "уровня содержания латекса" привел меня к LaTeX - настройке глубины оглавления для различных частей диссертации , что предполагает
\setcounter{tocdepth}{n}
, где n
начинается с ноль только для деления высшего уровня. Предположительно, это определено во всех стилях по умолчанию, но стоит попробовать в doxygen.