doxygen с IDL/ODL

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

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


person Mr. Boy    schedule 17.06.2010    source источник


Ответы (1)


Судя по этой странице, Doxygen отлично поддерживает синтаксический анализ файлов *idl и *.odl. Может быть, у вас есть проблемы с форматом комментариев?

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

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

person ereOn    schedule 17.06.2010
comment
Это была моя первоначальная мысль... но что происходит с классами, использующими эти интерфейсы... они включают файлы .h, так что не будет ли это означать "пробел" в цепочке? - person Mr. Boy; 17.06.2010
comment
Я не уверен в формате комментария, я установил его для генерации всего, даже если исходных комментариев нет (мы doxygenating существующий проект). Я получаю ссылку на xxx.odl, но при нажатии на нее не отображается источник файла, как в случае с файлами .h. - person Mr. Boy; 17.06.2010
comment
@John: я сомневаюсь, что Doxygen может генерировать ссылки на сгенерированные файлы (также известные как файлы, которые он не анализировал сам). О пробеле в цепочке: я думаю, это просто способ увидеть вещи ;) Имо, совершенно нормально думать, что некоторые несгенерированные классы используют сгенерированные файлы. Здесь нет настоящего разрыва: просто дополнительное звено (поколение). - person ereOn; 17.06.2010