crossplatform.ru

Здравствуйте, гость ( Вход | Регистрация )

 
Ответить в данную темуНачать новую тему
> qdoc3 - появилось руководство!
Litkevich Yuriy
  опции профиля:
сообщение 23.6.2009, 20:56
Сообщение #1


разработчик РЭА
*******

Группа: Сомодератор
Сообщений: 9656
Регистрация: 9.1.2008
Из: Тюмень
Пользователь №: 64

Спасибо сказали: 807 раз(а)




Репутация:   94  


Руководство по системе документирования Qt (из которой вырос DoxyGen) - QDoc
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение
igor_bogomolov
  опции профиля:
сообщение 23.6.2009, 21:25
Сообщение #2


Профессионал
*****

Группа: Сомодератор
Сообщений: 1215
Регистрация: 22.3.2009
Из: Саратов
Пользователь №: 630

Спасибо сказали: 235 раз(а)




Репутация:   29  


Раньше 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
  опции профиля:
сообщение 23.6.2009, 21:36
Сообщение #3


разработчик РЭА
*******

Группа: Сомодератор
Сообщений: 9656
Регистрация: 9.1.2008
Из: Тюмень
Пользователь №: 64

Спасибо сказали: 807 раз(а)




Репутация:   94  


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

Цитата(igor_bogomolov @ 24.6.2009, 1:25) *
То что есть на данный момент меня совершенно не устраевает.
а что не устраивает?
Дока по Qt выглядит приличнее чем то, что поумолчанию генерит DoxyGen.
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение
igor_bogomolov
  опции профиля:
сообщение 23.6.2009, 21:56
Сообщение #4


Профессионал
*****

Группа: Сомодератор
Сообщений: 1215
Регистрация: 22.3.2009
Из: Саратов
Пользователь №: 630

Спасибо сказали: 235 раз(а)




Репутация:   29  


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

В qdoc3 код и документация никак не связаны. Любое документирование внутри .h-файла, или внутри любого метода просто игнорируется.
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение
Litkevich Yuriy
  опции профиля:
сообщение 23.6.2009, 22:00
Сообщение #5


разработчик РЭА
*******

Группа: Сомодератор
Сообщений: 9656
Регистрация: 9.1.2008
Из: Тюмень
Пользователь №: 64

Спасибо сказали: 807 раз(а)




Репутация:   94  


Цитата(igor_bogomolov @ 24.6.2009, 1:56) *
В qdoc3 код и документация никак не связаны.
дану, все исходники Qt задокументированны в коде.

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

У QDoc другая проблемма, он непонимает по-русски и исправлять его я устал. Денис (из тролей) его правил для поддержки UTF-8. Но как там дальше дела развивались я не знаю, плюнул.
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение
igor_bogomolov
  опции профиля:
сообщение 23.6.2009, 22:11
Сообщение #6


Профессионал
*****

Группа: Сомодератор
Сообщений: 1215
Регистрация: 22.3.2009
Из: Саратов
Пользователь №: 630

Спасибо сказали: 235 раз(а)




Репутация:   29  


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

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

Ну а раз русский язык не поддерживается, то использование его для ведения своей документации не имеет смысла.
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение
CrackedMind
  опции профиля:
сообщение 21.7.2009, 4:38
Сообщение #7


Студент
*

Группа: Участник
Сообщений: 44
Регистрация: 13.3.2009
Пользователь №: 611

Спасибо сказали: 7 раз(а)




Репутация:   0  


Какая то документация совсем даже не полная :(
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение
ufna
  опции профиля:
сообщение 22.7.2009, 0:11
Сообщение #8


Активный участник
***

Группа: Участник
Сообщений: 362
Регистрация: 24.5.2008
Из: Курган/СПб
Пользователь №: 182

Спасибо сказали: 29 раз(а)




Репутация:   5  


а QDoc стал открыт массам? или планируется?
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение
CrackedMind
  опции профиля:
сообщение 22.7.2009, 0:58
Сообщение #9


Студент
*

Группа: Участник
Сообщений: 44
Регистрация: 13.3.2009
Пользователь №: 611

Спасибо сказали: 7 раз(а)




Репутация:   0  


Хм.
QTDIR/tools/qdoc3
Перейти в начало страницы
 
Быстрая цитата+Цитировать сообщение

Быстрый ответОтветить в данную темуНачать новую тему
Теги
Нет тегов для показа


1 чел. читают эту тему (гостей: 1, скрытых пользователей: 0)
Пользователей: 0




RSS Текстовая версия Сейчас: 1.4.2020, 8:27