Как создать документацию? Опции

[SABROG]

Тоже нету.

[Litkevich Yuriy]

мне сегоденя троли ответили (18 июня робот прислал уведомление о принятии заявки), по поводу этого дела, я им допинфу послал, будут разбиратся, у них такого эффекта нет.

[kuzulis]

Доброго времени.

Подниму эту ветку.


А как собственно, используя утилиту qdoc3 сгенерировать *.qch файлы (и т.п.) для открытия в ассистенте и т.п. ?

Я взял (как написано в документации к QDoc : http://doc.qt.nokia.com/qdoc/index.html) ,
создал минимальный файлик qserialdevice.qdocconf

# QDoc is a tool that constantly evolves to suit our needs,
# and there are some compatibility issues between old and new
# practices. For that reason, any QDoc configuration file needs to
# include compat.qdocconf.

#include(compat.qdocconf)

# The outputdir variable specifies the directory
# where QDoc will put the generated documentation.

outputdir = html

# The headerdirs variable specifies the directories
# containing the header files associated
# with the .cpp source files used in the documentation.

headerdirs = .

# The sourcedirs variable specifies the
# directories containing the .cpp or .qdoc
# files used in the documentation.

sourcedirs = .

# The exampledirs variable specifies the directories containing
# the source code of the example files.

exampledirs = .

# The imagedirs variable specifies the
# directories containing the images used in the documentation.

imagedirs = ./images

для своего проекта (правда, комменты в проекте в Doxygen стиле, но это ничего ),
запустил

qdoc3.exe ./qserialdevice.qdocconf

оно мне ругнулось на кучу неправильных комментов, но в итоге создало мне *.html файлы.

Так вот, можно ли сразу генерить *.qch файлы и как вообще происходит процесс перевода документации на русский?

Сообщение отредактировал kuzulis - 27.4.2011, 15:31

[Litkevich Yuriy]

Так вот, можно ли сразу генерить *.qch файлы

нет
сжатые файлы справки делаются так:

%QTDIR%/bin/qhelpgenerator.exe html-assistant-ru\assistant.qhp -o assistant_ru.qch

как вообще происходит процесс перевода документации на русский?

примерно так

[kuzulis]

нет
сжатые файлы справки делаются так:

1. Правильно ли я понимаю, что *.qch файлы содержат весь *.html контент только в своем определенном формате и для
ассистента достаточно только лишь этих *.qch файлов?
2. Что за файл *.qhp ?

примерно так

спс, почитаю

[Litkevich Yuriy]

для
ассистента достаточно только лишь этих *.qch файлов?

да

2. Что за файл *.qhp ?

Qt Help Project - проект справки Qt

[Гость_я_*]

Возник такой вопрос.
Пытаюсь создать файл qch из проекта в примерах (simpletextviewer), но qhelpgenerator просто вылетает с ошибкой.
Использую QtSDK 1.1rc, ОС WinXP SP3.
Никто с подобным не встречался?

[Litkevich Yuriy]

но qhelpgenerator просто вылетает с ошибкой.

тут форумчанам предлагается угадать ошибку?

[Гость_я_*]

Litkevich Yuriy
Если это поможет, то винда в формируемом отчете упоминает

Exception Information
Code: 0xc0000005

Пробовал запускать как из каталога bin, так и из каталога проекта:

C:\QtSDK\Desktop\Qt\4.7.3\mingw\bin>qhelpgenerator C:\QtSDK\Examples\4.7\help\simpletextviewer\documentation\simpletextv
iewer.qhp -o C:\QtSDK\Examples\4.7\help\simpletextviewer\documentation\simpletextviewer.qch

C:\QtSDK\Examples\4.7\help\simpletextviewer\documentation>C:\QtSDK\Desktop\Qt\4.7.3\mingw\bin\qhelpgenerator simpletextv
iewer.qhp -o simpletextviewer.qch

Перетаскивал каталог с документацией в bin:

C:\QtSDK\Desktop\Qt\4.7.3\mingw\bin>qhelpgenerator documentation\simpletextviewer.qhp -o documentation\simpletextviewer.
qch

C:\QtSDK\Desktop\Qt\4.7.3\mingw\bin>qhelpgenerator documentation\simpletextviewer.qhp -o simpletextviewer.qch

C:\QtSDK\Desktop\Qt\4.7.3\mingw\bin>qhelpgenerator simpletextviewer.qhp -o simpletextviewer.qch

Всё это делал, разумеется, предварительно удалив из каталога проекта сгенерированные до меня файлы qch, qhc и qhcp.

[Litkevich Yuriy]

проверил на 4.7.3:

H:\Qt\4.7.3_std\examples\help\simpletextviewer\documentation>qhelpgenerator simpletextviewer.qhp -o simpletextviewer.qch
Building up file structure...
Insert custom filters...
Insert help data for filter section (1 of 1)...
Insert files...
Insert contents...
Insert indices...
Documentation successfully generated.

H:\Qt\4.7.3_std\examples\help\simpletextviewer\documentation>

Ошибок ни каких небыло файл simpletextviewer.qch создался.
Затем делаю

H:\Qt\4.7.3_std\examples\help\simpletextviewer\documentation>qcollectiongenerator simpletextviewer.qhcp -o simpletextviewer.qhc
Reading collection config file...
Generating help for simpletextviewer.qhp...
Building up file structure...
Insert custom filters...
Insert help data for filter section (1 of 1)...
Insert files...
Insert contents...
Insert indices...
Documentation successfully generated.
Creating collection file...

H:\Qt\4.7.3_std\examples\help\simpletextviewer\documentation>

файл simpletextviewer.qhc

П.С. виндовоз у тебя какой?