Генерировать документацию как файлы разметки с использованием doxygen [закрыто]

19

Я знаю, что можно использовать markdown внутри комментариев, и doxygen может это понять. Но мне нужно знать, можно ли создать документацию в формате уценки?

Мне нужна эта документация, которая будет создана из файлов C ++.

    
задан Sudar 26.10.2012 в 08:38
источник
  • Я предполагаю, что используя исходный вывод XML, вы, вероятно, можете написать свой собственный модуль преобразования меток. Но я уверен (даже если не 100%) прямой вывод уценки пока невозможен. –  Christian Rau 26.10.2012 в 08:47

3 ответа

5

Я знаю, что этот вопрос старый, но, похоже, доступен новый инструмент: Ссылка

    
ответ дан bonanza 01.10.2016 в 15:20
  • Спасибо. Это похоже на хороший способ решить проблему, с которой я столкнулся. –  Sudar 02.10.2016 в 02:42
5

Я ничего не знаю о том, что будет делать это напрямую, но Doxygen имеет возможность выводить XML-документ с использованием генератора XML .

Существуют различные проекты, которые могут затем использовать упомянутые XML-данные для его преобразования, один из самых простых, о котором я знаю, Breathe , который используется для преобразования документов XML в нечто, что Sphinx может использовать для вывода документации с использованием Doxygen в качестве предварительного процессора, поэтому сказать.

Код для Breathe может быть достаточно простым, чтобы использовать в качестве отправной точки для создания файлов Markdown вместо файлов ReStructuredText, которые требуется Sphinx. Я не смотрел код для Breathe, но я использовал его для некоторых крупных проектов.

    
ответ дан X-Istence 31.10.2012 в 05:55
  • Breathe вставляет содержимое непосредственно в древовидную структуру Sphinx / docutils при анализе файлов Sphinx. Промежуточные файлы ReStructuredText никогда не создаются в процессе. –  Charles Ward 05.07.2017 в 22:03
5

Генерировать XML с помощью DOxygen Ссылка .

Используйте PanDoc Ссылка для преобразования XML в Markdown.

    
ответ дан mkuse 17.07.2015 в 13:01
  • Это фиктивный ответ: «XML» - очень общий формат, а pandoc не поддерживает вывод XML-сообщения doxygen. –  Tamás Szelei 24.06.2016 в 00:03