Это команда kgenapidox, которую можно запустить в бесплатном хостинг-провайдере OnWorks, используя одну из наших многочисленных бесплатных онлайн-рабочих станций, таких как Ubuntu Online, Fedora Online, онлайн-эмулятор Windows или онлайн-эмулятор MAC OS.
ПРОГРАММА:
ИМЯ
kgenapidox - Создание документации API в стиле KDE
Версия
5.13.0
ИСПОЛЬЗОВАНИЕ
использование: kgenapidox [-h] [--dependency-diagram-dir DEPENDENCY_DIAGRAM_DIR]
[--title НАЗВАНИЕ] [--man-pages] [--qhp] [--searchengine]
[--api-searchbox] [-o ВЫХОД] [--qtdoc-dir QTDOC_DIR]
[--qtdoc-ссылка QTDOC_LINK] [--qtdoc-flatten-ссылки]
[--kdedoc-dir KDEDOC_DIR] [--kdedoc-ссылка KDEDOC_LINK]
[--doxygen DOXYGEN] [--qhelpgenerator QHELPGENERATOR]
[--doxdatadir ДОКСДАТАДИР] [--keep-temp-dirs]
[модульдир]
необязательные аргументы:
-h, --help показать это справочное сообщение и выйти
Источники:
moduledir Расположение модуля, для которого создается документация по API;
он должен содержать файл README.md и src /
подкаталог. По умолчанию используется текущая папка.
--dependent-diagram-dir DEPENDENCY_DIAGRAM_DIR
Расположение dirs каркасной диаграммы; а "Зависимости"
страница будет включена в документацию по фреймворку
если предусмотрено.
варианты вывода:
--title TITLE Строка для использования в заголовках страниц.
--man-pages Сгенерировать справочную страницу документации.
--qhp Создать сжатую справочную документацию Qt.
--searchengine Включить функцию поисковой системы Doxygen.
--api-searchbox Включить окно поиска API (полезно только для
api.kde.org).
-o ВЫХОД, --output ВЫХОД
Место, где будет создаваться документация.
По умолчанию apidocs.
Документация Qt:
--qtdoc-каталог QTDOC_DIR
Расположение (локальной) документации Qt; это ищется
для файлов тегов для создания ссылок на классы Qt.
--qtdoc-ссылка QTDOC_LINK
Переопределить расположение документации Qt для ссылок в
файлы html. Может быть путем или URL-адресом.
--qtdoc-flatten-ссылки
Следует ли предполагать, что все html-файлы документации Qt
непосредственно под QTDOC_LINK (полезно, если вы установите
QTDOC_LINK в онлайн-документацию Qt). Игнорируется, если
QTDOC_LINK не установлен.
Документация KDE:
--kdedoc-dir KDEDOC_DIR
Расположение (локальной) документации KDE; это
искал файлы тегов для создания ссылок на классы KDE.
--kdedoc-ссылка KDEDOC_LINK
Переопределить расположение документации KDE для ссылок в
файлы html. Может быть путем или URL-адресом.
пути:
--doxygen DOXYGEN (Путь к) исполняемому файлу doxygen.
--qhelpgenerator QHELPGENERATOR
(Путь к) исполняемому файлу qhelpgenerator.
разное:
--doxdatadir ДОКСДАТАДИР
Расположение файлов заголовков HTML и поддержка
графика.
--keep-temp-dirs Не удалять временные каталоги, полезные для отладки.
АВТОРЫ
Эта версия капидокс был написан Орельеном Гато [электронная почта защищена].
Эта страница руководства была создана Скоттом Киттерманом.[электронная почта защищена]>.
2015-07-11 кгенапидокс(1)
Используйте kgenapidox онлайн с помощью сервисов onworks.net
