ocamldoc - Интернет в облаке

ПРОГРАММА:

ИМЯ

ocamldoc - Генератор документации OCaml

СИНТАКСИС

окамлдок [ кредита ] имя файла ...

ОПИСАНИЕ

Генератор документации OCaml окамлдок(1) генерирует документацию из специальных
комментарии, встроенные в исходные файлы. Комментарии, использованные окамлдок имеют форму (** ...
*) и следуйте формату, описанному в Команда OCaml пользователя Посмотреть руководство.

окамлдок может создавать документацию в различных форматах: HTML, LaTeX, TeXinfo, Unix man
страницы и dot(1) графы зависимостей. Более того, пользователи могут добавлять свои собственные генераторы.

В этой man-странице мы используем слово элемент ссылаться на любую из следующих частей
Исходный файл OCaml: объявление типа, значение, модуль, исключение, тип модуля,
конструктор типа, поле записи, класс, тип класса, метод класса, значение класса или
предложение о наследовании класса.

ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ

Следующие параметры командной строки определяют формат создаваемой документации.
Сгенерированно с помощью окамлдок(1).

Опции для Выбирая выходной формат
-html Создание документации в формате HTML по умолчанию. Сгенерированные HTML-страницы сохраняются
в текущем каталоге или в каталоге, указанном с помощью -d вариант. Ты можешь
настраивать стиль сгенерированных страниц, редактируя сгенерированные style.css файл,
или предоставив свою собственную таблицу стилей, используя опцию -css-стиль. Файл style.css
не создается, если он уже существует.

-латекс Создавать документацию в формате LaTeX по умолчанию. Сгенерированный документ LaTeX
сохранено в файле ocamldoc.out, или в файле, указанном с помощью -o вариант.
документ использует файл стиля ocamldoc.sty. Этот файл создается при использовании
-латекс вариант, если он еще не существует. Вы можете изменить этот файл, чтобы настроить
стиль вашей документации LaTeX.

-текси Создавать документацию в формате по умолчанию TeXinfo. Сгенерированный документ LaTeX
сохранено в файле ocamldoc.out, или в файле, указанном с помощью -o опцию.

-человек Сгенерируйте документацию в виде набора страниц руководства Unix. Сгенерированные страницы сохраняются
в текущем каталоге или в каталоге, указанном с помощью -d опцию.

-точка Создайте график зависимостей для модулей верхнего уровня в формате, подходящем для
отображение и обработка dot(1). dot(1) инструмент доступен из
http://www.research.att.com/sw/tools/graphviz/. Текстовое представление
график записан в файл ocamldoc.out, или в файл, указанный с помощью -o
вариант. Использовать dot ocamldoc.out для его отображения.

-g файл
Динамически загружать указанный файл (обычно с расширением .cmo или .cma), который
определяет настраиваемый генератор документации. Если данный файл простой и
не существует в текущем каталоге, то окамлдок ищет это в кастоме
генераторы каталог по умолчанию, и в каталогах, указанных с помощью -i опцию.

-customdir
Отображение каталога по умолчанию для настраиваемых генераторов.

-i каталог
Добавьте указанный каталог в путь, по которому следует искать настраиваемые генераторы.

Общие кредита
-d директория Создать файлы в каталоге директория, а не текущий каталог.

-дамп файл
Выгрузить собранную информацию в файл. Эту информацию можно прочитать с помощью -load
вариант в последующем вызове окамлдок(1).

-скрывать модули
Скрыть указанные полные имена модулей в сгенерированной документации. модули - это
список полных имен модулей через запятую (,), без пробелов. Для
пример: Повсеместно, M2.M3.

-inv-слияние мл-мли
При слиянии измените приоритет реализаций и интерфейсов. Все
элементы в файлах реализации сохраняются, а -m опция указывает, какие части
комментариев в файлах интерфейса объединены с комментариями в реализации
файлы.

-сохранительный код
Всегда сохраняйте исходный код для значений, методов и переменных экземпляра, когда
доступный. Исходный код всегда сохраняется, когда предоставляется файл .ml, но
по умолчанию сбрасывается, когда дается .mli. Эта опция позволяет исходному коду быть
всегда держал.

-load файл
Загрузить информацию из файл, который был произведен окамлдок -дамп, Несколько
-load варианты могут быть предоставлены.

-m Флаги
Укажите параметры слияния между интерфейсами и реализациями. Флаги может быть один или
несколько из следующих персонажей:

d описание слияния

a объединить @author

v объединить @version

l объединить @see

s объединить @since

o объединить @deprecated

p объединить @param

e объединить @raise

r объединить @return

A объединить все

-нет пользовательских тегов
Не разрешайте настраиваемые теги @.

-не останавливайся
Сохраняйте элементы, размещенные после (** / **) специальный комментарий.

-o файл
Выведите сформированную документацию в файл вместо ocamldoc.out. Этот вариант
имеет смысл только в сочетании с -латекс, -тексиили -точка настройки.

-pp команду
Передача исходников через препроцессор команду.

-ппкс команду
Передача абстрактного синтаксического дерева через препроцессор команду.

-Сортировать Перед созданием документации отсортируйте список модулей верхнего уровня.

то звезда Удалите пустые символы до первой звездочки ('*') в каждой строке комментариев.

-t название
Используйте название в качестве названия для созданной документации.

-вступление файл
Использовать содержание файл as окамлдок текст для использования в качестве введения (HTML, LaTeX и
Только TeXinfo). Для HTML файл используется для создания всего файла index.html.

-v Подробный режим. Отображение информации о ходе выполнения.

-версия
Распечатать строку версии и выйти.

-vnum Распечатайте короткий номер версии и выйдите.

-предупреждение-ошибка
Рассматривать окамлдок предупреждения как ошибки.

-hide-предупреждения
Не печатать окамлдок предупреждения.

-Помощь or --Помогите
Отобразите краткую сводку использования и выйдите.

Тип проверка кредита
окамлдок(1) вызывает средство проверки типов OCaml для получения информации о типе. Следующие варианты
влияют на фазу проверки типов. Они имеют то же значение, что и
окамлк(1) и окамлопт(1) команды.

-I каталог
Добавить каталог в список каталогов поиск скомпилированных интерфейсных файлов (.cmi
файлы).

-без меток
Игнорируйте необязательные метки в типах.

-ректипы
Разрешить произвольные рекурсивные типы. (См. -ректипы вариант окамлк(1)).

Опции для порождающий HTML страниц
Следующие параметры применяются вместе с -html опции:

-все параметры
Отобразите полный список параметров для функций и методов.

-css-стиль имя файла
Используйте имя файла как файл каскадной таблицы стилей.

-раскрасить-код
Раскрасьте код OCaml, заключенный в [] и \ {[] \}, используя цвета, чтобы выделить
ключевые слова и т. д. Если фрагменты кода синтаксически неверны, цвет не
добавлен.

-только индекс
Создавать только индексные файлы.

-короткие функторы
Используйте краткую форму для отображения функторов: модуль M : функтор (A: Модуль) -> функтор
(B: Модуль2) -> SIG .. конец отображается как модуль M (A: Модуль) (B: Модуль2) : SIG ..
конец.

Опции для порождающий Латекс файлов
Следующие параметры применяются вместе с -латекс опции:

-латекс-значение-префикс префикс
Задайте префикс, который будет использоваться для меток значений в сгенерированном документе LaTeX.
Префикс по умолчанию - пустая строка. Вы также можете использовать параметры -латекс-типа-
префикс, -latex-исключение-префикс, -латекс-модуль-префикс, -латекс-модуль-тип-префикс,
-префикс-класса-латекса, -латекс-класс-тип-префикс, -латекс-атрибут-префикси -латекс-
префикс метода.

Эти параметры полезны, когда у вас есть, например, тип и значение с
то же имя. Если вы не укажете префиксы, LaTeX будет жаловаться на умножение
определенные метки.

-латекститул n, стиль
Номер ассоциированного стиля n к данной команде секционирования LaTeX стиль, например
.orподраздел. (Только для LaTeX.) Это полезно при включении сгенерированных
документ в другом документе LaTeX на заданном уровне секционирования. По умолчанию
ассоциация: 1 для раздела, 2 для подраздела, 3 для подраздела, 4 для
абзац и 5 подпункт.

-нет заголовка
Скрыть заголовок в сгенерированной документации.

-ноток Не создавайте оглавление.

-нотрейлер
Скрыть трейлер в сгенерированной документации.

-sepfiles
Создайте один файл .tex для каждого модуля верхнего уровня вместо глобального ocamldoc.out
.

Опции для порождающий TeXinfo файлов
Следующие параметры применяются вместе с -текси опции:

-esc8 Экранируйте символы с диакритическими знаками в Info-файлах.

-информация-запись
Укажите запись в справочнике информации.

-информационный раздел
Укажите раздел справочника Info.

-нет заголовка
Скрыть заголовок в сгенерированной документации.

-без индекса
Не создавайте индекс для Info-файлов.

-нотрейлер
Скрыть трейлер в сгенерированной документации.

Опции для порождающий dot Графики
Следующие параметры применяются вместе с -точка опции:

-точечные цвета цвета
Укажите цвета для использования в сгенерированном точечном коде. При генерации модуля
зависимости, окамлдок(1) использует разные цвета для модулей, в зависимости от
каталоги, в которых они находятся. При генерации зависимостей типов, окамлдок(1)
использует разные цвета для типов, в зависимости от модулей, в которых они находятся
определены. цвета список названий цветов, разделенных запятыми (,), как в
Красный, синий, зеленый. Доступные цвета - это те, которые поддерживаются dot(1) инструмент.

-dot-include-все
Включите все модули в dot(1) вывод, а не только модули, указанные в команде
строки или загружен -load опцию.

-точка-уменьшить
Перед выводом точки выполните переходное сокращение графика зависимостей.
код. Это может быть полезно, если есть много транзитивных зависимостей, которые мешают
график.

-типы точек
Вывод точечного кода, описывающего график зависимости типов вместо модуля
граф зависимостей.

Опции для порождающий человек файлов
Следующие параметры применяются вместе с -человек опции:

-человек-мини
Вместо этого создавайте справочные страницы только для модулей, типов модулей, классов и типов классов.
страниц для всех элементов.

-человек-суффикс суффикс
Установите суффикс, используемый для сгенерированных имен файлов man. По умолчанию o, как в Список.o.

-человек-раздел .
Установите номер раздела, используемый для сгенерированных имен файлов man. По умолчанию 3.

Используйте ocamldoc онлайн с помощью сервисов onworks.net