WYSIWYG в Doxygen

Question

Я работаю над довольно крупным проектом, написанным на C. Идея состояла в том, чтобы создать библиотеку модульных блоков, которые можно использовать на нескольких платформах. Каждый модуль связан с текстовым документом в формате .docx (огромная боль для сравнения). В этих документах указан раздел интерфейса, в котором перечислены типы данных и общедоступные функции. Они часто несовместимы с фактической реализацией в коде, и просмотр всей этой документации был проблемой.

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

Есть ли какой-нибудь способ WYSIWYG больших блоков документации в doxygen? Я чувствую, что это улучшит количество людей, документирующих свой код, и качество этой документации. Я рассмотрел ссылки на HTML, но это разделяет документацию. Я также подумал о том, чтобы поместить их в html, но это также кажется болезненным и означает, что всем нужен WYSIWYG HTML-редактор (или некоторые html skillz).

Есть идеи, как сделать вещи проще и красивее?

Спасибо большое.

Answer 1

Моя надстройка, Документация по Atomineer Pro может помочь.

Он (пока) не предлагает wysiwyg, но он помогает в повседневном управлении и обновлении комментариев документации Doxygen или DocXML, что помогает поддерживать их синхронизацию с кодом и аккуратный / читаемый с минимальными усилиями - это обычно приводит к тому, что программисты фактически документируют вещи, потому что фактор хлопот сводится к минимуму.

Так что, извините, это не прямое решение вашей проблемы - но это может помочь вам сделать вашу команду лучше и эффективнее с помощью встроенных комментариев doxygen.

Answer 2

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

Answer 3

Вы можете добавить <pre> ... </pre> разделов в свои комментарии и, немного изменив .css, вы можете отформатировать его по своему вкусу.