 Создание документации Qt |
Здравствуйте, гость ( Вход | Регистрация )
  |
Алексей1153 опции профиля:
|
 2.2.2011, 19:13
Сообщение
#1
|
 фрилансер  Группа: Участник Сообщений: 2941 Регистрация: 19.6.2010 Из: Обливион Пользователь №: 1822 Спасибо сказали: 215 раз(а) Репутация:  34 
 |
А как и в каком формате делается документация к плагину (то есть, чтобы как обычно по F1 была возможность вызвать справку для класса)делается ? Где об этом почитать можно ?
о, кое на что наткнулся, буду изучать ) http://www.forum.crossplatform.ru/index.ph...ic=5119&hl= |
 |
  
|
|
igor_bogomolov опции профиля:
|
2.2.2011, 20:57
Сообщение
#2
|
|
Профессионал Группа: Сомодератор Сообщений: 1215 Регистрация: 22.3.2009 Из: Саратов Пользователь №: 630 Спасибо сказали: 235 раз(а) Репутация: 29
|
Почитай так же The Qt Help Framework
|
|
|
|
|
Алексей1153 опции профиля:
|
2.2.2011, 21:23
Сообщение
#3
|
|
фрилансер Группа: Участник Сообщений: 2941 Регистрация: 19.6.2010 Из: Обливион Пользователь №: 1822 Спасибо сказали: 215 раз(а) Репутация: 34
|
хорошо
очепятка "Однако, наличие фалов коллекции " недопереведено Цитата Проект справки Qt (Qt Help Project) .qhp The input file for the help generator consisting of the table of contents, indices and references to the actual documentation files (*.html); it also defines a unique namespace for the documentation. Сжатая справка Qt (Qt Compressed Help) .qch Выходной файл генератора справки. This binary file contains all information specified in the help project file along with all compressed documentation files. Проект коллекции справки Qt (Qt Help Collection Project) .qhcp The input file for the help collection generator. It contains references to compressed help files which should be included in the collection; it also may contain other information for customizing Qt Assistant. Коллекция справки Qt (Qt Help Collection) .qhc Выходной файл генератора коллекции. This is the file QHelpEngine operates on. It contains references to any number of compressed help files as well as additional information, such as custom filters. вот мой вариант перевода Проект справки Qt (Qt Help Project) .qhp Исходный файл генератора справки, состоящий из таблицы оглавления, индексов и ссылок на реальные файлы документации (*.html); также этот файл определяет уникальное пространство имён для документации, на которую он ссылается. Сжатая справка Qt (Qt Compressed Help) .qch [Выходной файл генератора справки]. Это двоичный файл, содержащий всю информацию, расположенную в файле проекта-справки, вместе со сжатыми файлами документации. Проект коллекции справки Qt (Qt Help Collection Project) .qhcp Исходный файл для генератора коллекции справки. Содержит ссылки на сжатые файлы справки, которые нужно включить в коллекцию; также может содержать информацию о пользовательских настройках (customizing) программы Qt Assistant. Коллекция справки Qt (Qt Help Collection) .qhc [Выходной файл генератора коллекции.] Это файл, с которым взаимодействует класс QHelpEngine. Содержит ссылки на любое количество сжатых файлов справки и дополнительную информацию, например пользовательские фильтры. |
|
|
|
|
igor_bogomolov опции профиля:
|
2.2.2011, 21:35
Сообщение
#4
|
|
Профессионал Группа: Сомодератор Сообщений: 1215 Регистрация: 22.3.2009 Из: Саратов Пользователь №: 630 Спасибо сказали: 235 раз(а) Репутация: 29
|
Алексей1153, дай, на всякий случай, ссылку на этот пост в подфоруме "переводы"
|
|
|
|
|
Алексей1153 опции профиля:
|
2.2.2011, 21:41
Сообщение
#5
|
|
фрилансер Группа: Участник Сообщений: 2941 Регистрация: 19.6.2010 Из: Обливион Пользователь №: 1822 Спасибо сказали: 215 раз(а) Репутация: 34
|
ну, в общих чертах то понятно.
Осталось узнать , как делать html-документы ) А где пример можно глянуть ? Я нашёл в папке креатора файлы QCH (бишь сжатая справка), а чем она сжатая - как расжать ? |
|
|
|
|
igor_bogomolov опции профиля:
|
2.2.2011, 21:48
Сообщение
#6
|
|
Профессионал Группа: Сомодератор Сообщений: 1215 Регистрация: 22.3.2009 Из: Саратов Пользователь №: 630 Спасибо сказали: 235 раз(а) Репутация: 29
|
Цитата Создание справки Qt
Сборка файлов справки для справочной системы Qt предполагает, что html-файлы документации уже существуют, т.е. справочная система Qt не предоставляет возможности создания html-файлов, как например, Doxygen. Если html-документы присутствуют, файл проекта справки Qt должен быть создан. После указания всей необходимой информации в этом файле, его необходимо скомпилировать вызвав: qhelpgenerator doc.qhp -o doc.qch Файл 'doc.qch' будет содержать все html-файлы в сжатой форме вместе с оглавлением и предметным указателем. Чтобы проверить, является ли созданный файл правильным, откройте Qt Assistant и установите файл через страницу Settings|Documentation. |
|
|
|
|
Алексей1153 опции профиля:
|
2.2.2011, 21:55
Сообщение
#7
|
|
фрилансер Группа: Участник Сообщений: 2941 Регистрация: 19.6.2010 Из: Обливион Пользователь №: 1822 Спасибо сказали: 215 раз(а) Репутация: 34
|
Цитата(igor_bogomolov @ 2.2.2011, 23:48)  предполагает, что html-файлы документации уже существуют а они ещё не существуют. Мне их надо написать. Нужен пример )) поясню - понятия не имею, какие элементы HTML должны присутствовать, никогда не сталкивался с ним |
|
|
|
|
igor_bogomolov опции профиля:
|
2.2.2011, 21:59
Сообщение
#8
|
|
Профессионал Группа: Сомодератор Сообщений: 1215 Регистрация: 22.3.2009 Из: Саратов Пользователь №: 630 Спасибо сказали: 235 раз(а) Репутация: 29
|
Загляни на этот ресурс http://htmlbook.ru/
Там и справочник тегов есть, и самоучитель неплохой |
|
|
|
|
Алексей1153 опции профиля:
|
2.2.2011, 22:04
Сообщение
#9
|
|
фрилансер Группа: Участник Сообщений: 2941 Регистрация: 19.6.2010 Из: Обливион Пользователь №: 1822 Спасибо сказали: 215 раз(а) Репутация: 34
|
ага, то, что надо )
приятный такой дизайн сайта, кстати Сообщение отредактировал Алексей1153 - 2.2.2011, 22:13 |
|
|
|
|
Obey-Kun опции профиля:
|
3.2.2011, 3:59
Сообщение
#10
|
 Студент Группа: Участник Сообщений: 96 Регистрация: 24.3.2010 Пользователь №: 1556 Спасибо сказали: 3 раз(а) Репутация: 0
|
Сама документация компилируется при помощи doxygen. Посмотрите исходники Qt, документация в них встроена. Вот например — http://qt.gitorious.org/qt/qt/blobs/4.7/sr...rnel/qtimer.cpp.
Я в своих проектах тоже пишу doxygen-совместимые комментарии. Это вообще хорошая практика. Сообщение отредактировал Obey-Kun - 3.2.2011, 4:03 |
|
|
|
 |
Теги
Нет тегов для показа
5 чел. читают эту тему (гостей: 5, скрытых пользователей: 0)
Пользователей: 0
|
|
Текстовая версия | Сейчас: 24.12.2024, 6:02 |