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