Файл уценки с оглавлением, экспортированным в документацию doxygen, не создает TOC в HTML

Существует файл уценки, который я использую для создания части документации doxygen с помощью директив cmake и операторов doxyfile.in. Сгенерированная документация почти правильная. На самом деле этот файл уценки является главной страницей документации doxygen.

Начало файла уценки читается

# Title1

[TOC]
## Title2

и остальная часть документа продолжается. Тем не менее, когда я генерирую документацию doxygen, оглавление не появляется. Пожалуйста, кто-нибудь что-нибудь знает?


person lmc    schedule 30.03.2018    source источник


Ответы (1)


Здесь мы имеем дело с оглавлением на странице.

Похоже, что проблем несколько.

1) [TOC] должен быть перед первым заголовком (т. е. # Title1) (в этом случае оглавление по-прежнему неверно, если не указаны другие команды, такие как \page.)

2) TOC_INCLUDE_HEADINGSDoxyfile, то есть в файле конфигурации doxygen) должно быть установлено значение > 0, чтобы получить оглавление на n страницах. Из документации Doxyfile/doxygen:

# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 0.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
person albert    schedule 31.03.2018
comment
Я только что отправил предложенный патч документации на github (запрос на включение 688, github.com/doxygen/ doxygen/pull/688). - person albert; 31.03.2018
comment
Ваш ответ правильный, это сработало. Если я позволю [TOC] после первого заголовка, в оглавлении не будут отображаться правильные заголовки, а ссылки останутся неработающими. - person lmc; 31.03.2018
comment
Замечание правильное (относительно места [TOC]), doxygen выдает предупреждение и неверное TOC. У меня также была команда \page, которая снова дает правильные результаты (это все довольно сложные возможности уценки вместе с обычными командами doxygen). Я исправлю ответ, чтобы вы могли его принять. - person albert; 01.04.2018