Russian Qt Forum

Программирование => Общий => Тема начата: Rcus от Апрель 17, 2009, 18:09



Название: Doxygen, документирование перечислений
Отправлено: Rcus от Апрель 17, 2009, 18:09
Диспозиция такова:
по-умолчанию Doxygen генерирует для enum'ов полное описание объявления в заголовке с численным значениями (если указаны), в детальном описании идет таблица без численных значений.

А хотелось бы получить вид аналогичный документации Qt: без значений в заголовке и таблицу со значениями в деталях. И совсем уж круто было бы узнать как разбить документацию значений по группам.

Маны раскуривал, гугл мучал, но :(


Название: Re: Doxygen, документирование перечислений
Отправлено: igor_bogomolov от Апрель 19, 2009, 13:59
А хотелось бы получить вид аналогичный документации Qt
Qt не использует Doxygen для генерации документации. У них есть QTDIR\tools\qdoc3.
Если хотите иметь документацию в стиле Qt, можете использовать эту утилиту. Помимо html, с ее помощь можно также одновременно сгенерировать .qhp файлы.

Правда там есть свои недостатни. ИМХО.


Название: Re: Doxygen, документирование перечислений
Отправлено: Rcus от Апрель 19, 2009, 14:15
qdoc3 не хотеть:
во-первых к нему никакого хелпа,
во-вторых его не рекомендуют использовать, о чем указано в README.TXT,
в-третьих Doxygen тоже умеет qch/qhp, о чем была статья в QQ (и при подключении в хелп креатора даже контекстная справка работает)


Название: Re: Doxygen, документирование перечислений
Отправлено: igor_bogomolov от Апрель 19, 2009, 14:38
во-первых к нему никакого хелпа,
Можно в исходниках подсматривать необходимое оформление.

Другого способа навести такие красивости, как вы хотите я не знаю. Если только самому таблицу формировать через <TABLE>.

Если найдете способ, отпишитесь, мне тоже интересно :)


Название: Re: Doxygen, документирование перечислений
Отправлено: Rcus от Апрель 20, 2009, 09:06
Более методичное раскуривание манов приносит свои плоды:
Doxygen умеет генерировать документацию в XML формате и в ней есть вся нужная информация. Проблема только в том чтобы преобразовать XML в человечный HTML, но на сайте Doxygen есть несколько линков, как продвинусь в этом деле отпишусь.