Сочетание документов документации Docbook и Doxygen.

Question

Я работаю над новой документацией для нашей библиотеки программного обеспечения, и мне интересно, как я могу объединить общую документацию, которая, как мне кажется, должна быть написана в DocBook вместе с ссылкой на API на основе Doxygen.

Часть Doxygen уже существует, поэтому я предпочитаю ее хранить, но использование DocBook - это просто идея, и я открыт для любых идей. Написание всей документации в Doxygen возможно, но мне кажется, что это не лучший подход.

Спасибо!

Answer 1

Я бы порекомендовал вам пересмотреть ход всеоднородного пути. Несмотря на то, что написание сложной документации с использованием Doxygen может показаться громоздкой вначале, поддержание двух последовательных документов будет более продолжительным. Помимо добавленной рабочей нагрузки, вы комбинируете выходные продукты обоих.

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

Я также должен добавить, что у меня не было предыдущего опыта из первых рук с Docbook, так что я мог бы немного уклониться от Doxygen.