Это командная пикета, которую можно запустить в бесплатном хостинг-провайдере OnWorks, используя одну из наших многочисленных бесплатных онлайн-рабочих станций, таких как Ubuntu Online, Fedora Online, онлайн-эмулятор Windows или онлайн-эмулятор MAC OS.
ПРОГРАММА:
ИМЯ
haddock - инструмент документации для аннотированного исходного кода Haskell
СИНТАКСИС
пикша [кредита] файл...
ОПИСАНИЕ
Эта страница руководства кратко документирует пикша команда. Обширная документация
доступны в различных других форматах, включая DVI, PostScript и HTML; см. ниже.
файл - имя файла, содержащего исходный модуль Haskell. Все модули, указанные на
командная строка будет обрабатываться вместе. Когда один модуль ссылается на объект в другом
обрабатываемого модуля, документация будет напрямую связана с этим объектом.
Сущности, которые не могут быть найдены, например, потому что они находятся в модуле, который не
обрабатывается как часть текущего пакета, просто не будет гиперссылки в сгенерированном
документация. пикша выдаст предупреждения со списком всех идентификаторов, которые он не мог
разрешить.
Модули не должны быть взаимно рекурсивными, поскольку пикша не любит плавать в
круги.
ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ
Программы следуют обычному синтаксису командной строки GNU с длинными параметрами, начинающимися с двух
тире (`- '). Сводка опций приведена ниже. Полное описание см.
другая документация.
-o DIR, --odir =DIR
каталог, в который помещаются выходные файлы
-i ФАЙЛОВ, --read-interface =ФАЙЛОВ
читать интерфейс из ФАЙЛОВ.
-D ФАЙЛОВ, --dump-interface =ФАЙЛОВ
дамп интерфейса для этих модулей в ФАЙЛОВ.
-l DIR, --lib =DIR
расположение вспомогательных файлов Пикши
-h, --html
Создавать документацию в формате HTML. Несколько файлов будут сгенерированы в
текущий каталог (или указанный каталог, если -o предоставляется вариант), в том числе
следующие:
index.html
Страница верхнего уровня документации: перечисляет доступные модули, используя
отступ для представления иерархии, если модули являются иерархическими.
пикша.css
Таблица стилей, используемая сгенерированным HTML. Не стесняйтесь изменить это на
изменить цвета или макет или даже указать собственную таблицу стилей с помощью
--css опцию.
модуль.html
HTML-страница для каждого модуля.
doc-index.html, doc-index-XX.html
Индекс, разделенный на две части (функции / конструкторы и типы / классы, согласно
Пространства имен Haskell) и далее разбиваются по алфавиту.
- hoogle
вывод для Google
--html-help =формат
создать индекс и оглавление в формате mshelp, mshelp2 или devhelp (с -h)
--source-base =URL
Включите ссылки на исходные файлы в сгенерированную документацию, где URL - это
базовый URL-адрес, по которому можно найти исходные файлы.
-s URL-адреса, --source-module =URL
Включите ссылки на исходные файлы в сгенерированную документацию, где URL-адрес
ссылка на исходный код для каждого модуля (с использованием переменных% {FILE} или% {MODULE}).
--source-entity =URL
Включите ссылки на исходные файлы в сгенерированную документацию, где URL-адрес
ссылка на исходный код для каждого объекта (с использованием переменных% {FILE},% {MODULE} или% {NAME}).
--comments-base =URL
URL-адрес ссылки для комментариев на страницах содержания и индекса.
--comments-module =URL
URL-адрес ссылки для комментариев для каждого модуля (с использованием переменной% {MODULE}).
--comments-entity =URL
URL для ссылки на комментарии для каждого объекта (с использованием% {FILE},% {MODULE} или% {NAME}
вары).
--css =ФАЙЛОВ
Используйте CSS ФАЙЛОВ вместо таблицы стилей по умолчанию, которая поставляется с пикша для HTML
выход. Он должен указывать определенные классы: подробности см. В таблице стилей по умолчанию.
-p ФАЙЛОВ, --prologue =ФАЙЛОВ
Укажите файл, содержащий текст пролога.
-t TITLE, --title =TITLE
Используйте TITLE как заголовок каждой страницы в документации. Это будет
обычно это имя документируемой библиотеки.
Заголовок должен быть простой строкой (без разметки, пожалуйста!).
-k ИМЯ, --package =ИМЯ
Укажите имя пакета (необязательно).
-n, - не-неявная-прелюдия
не предполагайте, что Prelude импортирован
-d, --отлаживать
Включить дополнительный вывод отладки.
-?, --Помогите
Показать справку.
-V, --версия
Показать версию.
-v, --подробный
Подробный отчет о статусе.
--use-contents =URL
Используйте отдельно созданную страницу содержимого HTML.
--gen-content
Сгенерировать содержимое HTML из указанных интерфейсов.
--use-index =URL
Используйте отдельно созданный HTML-индекс.
--gen-индекс
Сгенерировать HTML-индекс из указанных интерфейсов.
- игнорировать-все-экспорт
Ведите себя так, как будто все модули имеют атрибут игнорирования экспорта.
--hide =МОДУЛЬ
Вести себя как будто МОДУЛЬ имеет атрибут скрытия.
--use-package =ПАКЕТ
Обрабатываемые модули зависят от ПАКЕТ.
Используйте пикшу онлайн с помощью сервисов onworks.net
