ocamldoc - Інтернет у хмарі

ПРОГРАМА:

ІМ'Я

ocamldoc - генератор документації OCaml

СИНТАКСИС

ocamldoc [ опції ] ім'я файлу ...

ОПИС

Генератор документації OCaml ocamldoc(1) формує документацію зі спец
коментарі, вбудовані у вихідні файли. Коментарі, якими користуються ocamldoc мають форму (** ...
*) і дотримуйтесь формату, описаного в Команда OCaml user's керівництво.

ocamldoc може створювати документацію в різних форматах: HTML, LaTeX, TeXinfo, Unix man
сторінки та точка(1) графіки залежностей. Крім того, користувачі можуть додавати свої власні генератори.

На цій довідковій сторінці ми використовуємо слово елемент посилатися на будь-яку з наступних частин an
Вихідний файл OCaml: оголошення типу, значення, модуль, виняток, тип модуля,
конструктор типу, поле запису, клас, тип класу, метод класу, значення класу або
застереження про спадкування класу.

ВАРІАНТИ

Наступні параметри командного рядка визначають формат створеної документації
породжений ocamldoc(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 варіант.

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

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

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

-i каталог
Додайте вказаний каталог до шляху, де шукати користувацькі генератори.

Загальне опції
-d реж Створення файлів у каталозі реж, а не поточний каталог.

- звалище файл
Скидайте зібрану інформацію в файл. Цю інформацію можна прочитати за допомогою -навантаження
варіант у наступному виклику ocamldoc(1).

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

-inv-merge-ml-mli
Змінити пріоритет реалізацій та інтерфейсів під час злиття. всі
елементи у файлах реалізації зберігаються, і -m опція вказує, які частини
коментарів у файлах інтерфейсу об'єднуються з коментарями в реалізації
файли.

-збереження коду
Завжди зберігайте вихідний код для значень, методів і змінних екземплярів, коли
доступний. Вихідний код завжди зберігається, коли надається файл .ml, але він зберігається
за замовчуванням відкидається, коли вказано .mli. Цей параметр дозволяє використовувати вихідний код
завжди зберігався.

-навантаження файл
Завантажити інформацію з файл, який був вироблений ocamldoc - звалище. Кілька
-навантаження можна надати варіанти.

-m прапори
Вкажіть параметри злиття між інтерфейсами та реалізаціями. прапори може бути одним або
кілька з наступних символів:

d опис злиття

a об'єднати @author

v об'єднати @version

l об'єднати @див

s об'єднати @з

o об'єднати @deprecated

p об'єднати @param

e об'єднати @raise

r об'єднати @return

A об’єднати все

-без користувацьких тегів
Не дозволяти спеціальні теги @.

- без зупинки
Зберігайте елементи, розміщені після (**/**) спеціальний коментар.

-o файл
Виведіть створену документацію до файл замість ocamldoc.out. Цей варіант є
має значення лише в поєднанні з -латекс, -тексіабо -крапка Варіанти.

-стор команда
Передача джерел через препроцесор команда.

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

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

-зірки Видаліть порожні символи до першої зірочки ('*') у кожному рядку коментарів.

-t назву
Скористайтеся кнопкою назву як заголовок створеної документації.

- вступ файл
Використовуйте вміст файл as ocamldoc текст для введення (HTML, LaTeX і
Тільки TeXinfo). Для HTML файл використовується для створення всього файлу "index.html".

-v Детальний режим. Відображати інформацію про прогрес.

-версія
Роздрукувати рядок версії та вийти.

-внум Надрукуйте короткий номер версії та вийдіть.

-попередження-помилка
Лікувати ocamldoc попередження як помилки.

-приховати-попередження
Не друкувати ocamldoc попередження.

-допомога or --допомога
Відобразити короткий підсумок використання та вийти.

Перевірка типу опції
ocamldoc(1) викликає засіб перевірки типів OCaml для отримання інформації про тип. Наступні варіанти
вплив на фазу перевірки типу. Вони мають те ж значення, що і для
ocamlc(1) і окамлопт(1) команди.

-I каталог
додавати каталог у списку каталогів шукайте скомпільовані файли інтерфейсу (.cmi
файли).

-номітки
Ігноруйте необов’язкові мітки в типах.

-прямі типи
Дозволити довільні рекурсивні типи. (Див -прямі типи варіант до ocamlc(1)).

Опції та цінності породжує HTML сторінок
Наступні варіанти застосовуються разом із -html опції:

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

-css-стиль ім'я файлу
Скористайтеся кнопкою ім'я файлу як файл каскадної таблиці стилів.

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

-лише індекс
Генерувати лише індексні файли.

-короткі функтори
Використовуйте коротку форму для відображення функторів: Модулі M : функтор (A: Модуль) -> функтор
(B: Модуль 2) -> сиг .. кінець відображається як Модулі M (A: Модуль) (B: Модуль 2) : сиг ..
кінець.

Опції та цінності породжує LaTeX файли
Наступні варіанти застосовуються разом із -латекс опції:

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

Ці параметри корисні, якщо у вас є, наприклад, тип і значення з
те саме ім'я. Якщо ви не вкажете префікси, LaTeX скаржиться на multiply
визначені мітки.

-латекстиль п, стиль
Асоційований номер стилю n до заданої команди розділення LaTeX стиль, напр
розділorпідрозділ. (Тільки для LaTeX.) Це корисно при включенні згенерованого
документ в іншому документі LaTeX на заданому рівні розділів. За замовчуванням
асоціація 1 для розділу, 2 для підрозділу, 3 для підрозділу, 4 для
абзац і 5 підпункт.

-без заголовка
Придушити заголовок у створеній документації.

-notoc Не створюйте зміст.

-нотрейлер
Придушити трейлер у створеній документації.

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

Опції та цінності породжує TeXinfo файли
Наступні варіанти застосовуються разом із -тексі опції:

-esc8 Екранувати акцентовані символи в інформаційних файлах.

- інформаційний вхід
Вкажіть запис довідника інформації.

-інфо-розділ
Вкажіть розділ довідника Info.

-без заголовка
Придушити заголовок у створеній документації.

-noindex
Не створюйте індекс для інформаційних файлів.

-нотрейлер
Придушити трейлер у створеній документації.

Опції та цінності породжує точка графіки
Наступні варіанти застосовуються разом із -крапка опції:

- крапкові кольори квітів
Вкажіть кольори, які будуть використовуватися в згенерованому коді точки. При генерації модуля
залежності, ocamldoc(1) використовує різні кольори для модулів, залежно від
каталоги, в яких вони знаходяться. Під час створення залежностей типів, ocamldoc(1)
використовує різні кольори для типів, залежно від модулів, у яких вони знаходяться
визначений. квітів це список назв кольорів, розділених комами (,), як у
Червоний, синій, зелений. Доступні кольори – це ті, які підтримуються точка(1) інструмент.

-крапка-включити-все
Включіть всі модулі в точка(1) вихід, а не тільки модулі, надані командою
лінії або завантажені з -навантаження варіант.

- крапка зменшити
Виконайте транзитивне скорочення графіка залежностей перед виведенням точки
код. Це може бути корисно, якщо є багато транзитивних залежностей, які захаращують
графік.

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

Опції та цінності породжує людина файли
Наступні варіанти застосовуються разом із -людина опції:

-чоловік-міні
Натомість генеруйте сторінки керівництва лише для модулів, типів модулів, класів і типів класів
сторінок для всіх елементів.

-мужчина-суфікс Суфікс
Встановіть суфікс, який використовується для згенерованих імен файлів man. За замовчуванням є o, як у List.o.

-чоловік-секція розділ
Встановіть номер розділу, який використовується для створених імен файлів man. За замовчуванням 3.

Використовуйте ocamldoc онлайн за допомогою служб onworks.net