Помощь - Поиск - Пользователи - Календарь
Полная версия этой страницы: qdoc3 - появилось руководство!
Форум на CrossPlatform.RU > Библиотеки > Qt > Qt Общие вопросы
Litkevich Yuriy
Руководство по системе документирования Qt (из которой вырос DoxyGen) - QDoc
igor_bogomolov
Раньше Qt не рекомендовала использовать qdoc3 для ведения документации по коду.
Цитата
qdoc3 is the tool used to generate the Qt reference documentation.
The source code is included as part of this package primarily to
fulfill our GPL obligations. We highly recommend using
Doxygen (http://www.stack.nl/~dimitri/doxygen/) for generating
documentation for your Qt-based application.


Правильно ли я понимаю, что сейчас ситуация изменится?
Есть ли какие изменения в qdoc3? То что есть на данный момент меня совершенно не устраевает.
Litkevich Yuriy
Цитата(igor_bogomolov @ 24.6.2009, 1:25) *
Правильно ли я понимаю, что сейчас ситуация изменится?
Они будут его использовать для своей документации. Я думаю поэтому выложили руководство.

Цитата(igor_bogomolov @ 24.6.2009, 1:25) *
То что есть на данный момент меня совершенно не устраевает.
а что не устраивает?
Дока по Qt выглядит приличнее чем то, что поумолчанию генерит DoxyGen.
igor_bogomolov
Цитата(Litkevich Yuriy @ 23.6.2009, 22:36) *
а что не устраивает?
Дока по Qt выглядит приличнее чем то, что поумолчанию генерит DoxyGen.
Выглядит на самом деле прилично. Поэтому и появился интерес к ней. Но сразу наткнулся на кучу неудобств, из-за которой отказался от ее использования. Сам Doxygen, оказался очень удобен и прост в использовании.

В qdoc3 код и документация никак не связаны. Любое документирование внутри .h-файла, или внутри любого метода просто игнорируется.
Litkevich Yuriy
Цитата(igor_bogomolov @ 24.6.2009, 1:56) *
В qdoc3 код и документация никак не связаны.
дану, все исходники Qt задокументированны в коде.

Цитата(igor_bogomolov @ 24.6.2009, 1:56) *
Любое документирование внутри .h-файла, или внутри любого метода просто игнорируется.
я думаю это связанно с настройками

У QDoc другая проблемма, он непонимает по-русски и исправлять его я устал. Денис (из тролей) его правил для поддержки UTF-8. Но как там дальше дела развивались я не знаю, плюнул.
igor_bogomolov
Цитата(Litkevich Yuriy @ 23.6.2009, 23:00) *
дану, все исходники Qt задокументированны в коде.
Я дальше пояснил, что имею в виду.
Цитата(igor_bogomolov @ 23.6.2009, 22:56) *
Любое документирование внутри .h-файла, или внутри любого метода просто игнорируется.

Цитата(Litkevich Yuriy)
я думаю это связанно с настройками
Может быть. Но т.к. раньше никакого описания не было, обойти проблему не смог. Лазание по исходникам резальтата не дало, не встретил нигде документирования внутри кода

Ну а раз русский язык не поддерживается, то использование его для ведения своей документации не имеет смысла.
CrackedMind
Какая то документация совсем даже не полная :(
ufna
а QDoc стал открыт массам? или планируется?
CrackedMind
Хм.
QTDIR/tools/qdoc3
Для просмотра полной версии этой страницы, пожалуйста, пройдите по ссылке.
Форум IP.Board © 2001-2024 IPS, Inc.