Генерация однофайловой HTML-документации - PullRequest
12 голосов
/ 17 декабря 2008

Как я могу использовать Doxygen для создания HTML-документации в виде одного очень длинного файла? Я хочу что-то вроде вывода RTF, но как HTML.

Причина: мне нужно, чтобы мой API был опубликован как один печатный документ. Что-то, что можно загрузить в Word, конвертировать в PDF и т. Д.

Ответы [ 2 ]

4 голосов
/ 17 декабря 2008

Я думаю, вы можете использовать HTMLDOC для преобразования созданных HTML-файлов в один HTML-файл. (Сам не пробовал)

Руководство включает в себя следующий пример для генерации html из двух исходных html-файлов:

htmldoc --book -f output.html file1.html file2.html

Но есть и графический интерфейс.

2 голосов
/ 17 декабря 2008

Я не думаю, что есть опция, которая будет выводить вывод в виде одного файла HTML, но вывод RTF может подойти, если вам нужен редактируемый формат вывода (я сам не пробовал, поэтому не знаю насколько хорошо это работает).

Если вы хотите печатать вывод хорошего качества, то Doxygen может выводить формат LaTeX (установите GENERATE_LATEX в YES в вашем файле конфигурации doxygen). Затем его можно конвертировать в PDF, хотя вам нужно будет установить дистрибутив LaTeX, например MiKTeX .

...