doxygen с IDL/ODL

Если у вас есть проект на C++, который имеет кучу файлов .ODL и сгенерированные файлы .h из компилятора ODL, следует сделать doxygen для анализа как .odl, так и .h или только один или другой? В общем, мне не нравится документировать сгенерированный код, но IDL - это особый случай.doxygen с IDL/ODL

В любом случае, похоже, что список членов ODL-файлов не работает должным образом в моих тестах, правильно ли обрабатываются файлы ODL?

источник

2010-06-17 Mr. Boy

От this page кажется, что Doxygen отлично поддерживает парсинг *idl и *.odl. Может быть, у вас есть некоторые вопросы относительно формата комментариев?

В любом случае, я бы посоветовал вам разобрать *.idl/*.odl и сгенерировал .h файлов. Последние по определению генерируют и представляют те же классы, что и те, которые определены в файлах *.idl/*.old.

Разбор обоих состоит в том, чтобы документировать один и тот же набор классов дважды, что, очевидно, не очень хорошая идея.

источник

2010-06-17 09:32:16 ereOn

Это была моя первоначальная мысль ... но что происходит с классами, использующими эти интерфейсы ... они включают файлы .h, так что это не означает «пробел» в цепочке? –

Я не уверен в формате комментариев, я настроил его генерировать, даже если нет комментариев к источнику (мы используем существующий проект). Я получаю ссылку на «xxx.odl», но нажатие на нее не показывает мне источник файла, например, с .h-файлами. –

@John: Я сомневаюсь, что Doxygen может генерировать ссылки на сгенерированные файлы (ака. Файлы, которые он сделал ** не ** самостоятельно разбирать). О «пробеле» в цепочке: я думаю, что это просто способ увидеть вещи;) Имо, прекрасно, что некоторые порожденные классы используют сгенерированные файлы. Здесь нет реального «пробела»: просто дополнительная «ссылка» («поколение»). – ereOn

doxygen с IDL/ODL

ответ

Смежные вопросы