Описание тега ocamldoc
Генератор документации OCaml
1
ответ
Ocamldoc и открытые модули
Я пытаюсь документировать небольшой проект с помощью ocamldoc.У меня есть один главный .ml файл который opens два других .ml файлы. $ ocamldoc -html included1.ml included2.ml Работает просто отлично, но когда я добавляю включающий файл, вроде $ ocam…
07 окт '16 в 15:53
1
ответ
Почему ocamldoc не работает на несвязанных модулях?
Вот пример интерфейса test.mliс комментариями в стиле ocamldoc: (** ocamldoc module comment *) open MissingModule;; (** ocamldoc function comment *) val test : unit;; Если я запускаю команду ocamldoc test.mliЯ получаю следующую ошибку: File "test.ml…
18 апр '12 в 20:56
0
ответов
Как запустить dune build @doc с аргументами
У меня есть проект ocaml с использованием Dune. Я хочу создавать документацию с использованием Odoc. В настоящее время работает dune build @doc работает, но я хочу перейти в -short-functors вариант для одока. Как передать параметры Одоку через Дюну?
07 фев '19 в 13:25
2
ответа
Использование ocamldoc с пакетами
У меня есть проект ocamlbuild, который включает некоторые файлы в подкаталог с файлом.mlpack, перечисляя их. например, у меня есть файл support/logging.ml который определяет модуль Support.Logging, _tags файл говорит "support": for-pack(Support), Эт…
28 июн '13 в 15:44
1
ответ
Как создать документацию для OCaml на основе сигнатур модулей?
Я имею a.ml как это: module type ASig = sig val do_something : unit -> int;; end ;; module A:ASig = struct let do_something () = 1;; let do_secrectly () = 2;; end;; Так что для моего модуля А интерфейс должен быть только do_something() , Но если …
07 май '13 в 09:56
2
ответа
Генерация классоподобных диаграмм для OCaml
У меня есть большая база кода OCaml, и я хотел бы получить из нее некоторые UML-подобные диаграммы классов / модулей, подобно тому, как это делают некоторые инструменты обратного инжиниринга Java. Эти диаграммы не обязательно должны быть формальными…
06 июл '15 в 08:03
1
ответ
Ошибка генерации #OCaml ocamldoc
Здравствуйте, я пытаюсь сгенерировать документацию ocaml с ocamldoc. Я пытаюсь следующую команду: ocamldoc -html alpha.mli -d doc/ Но у меня есть эта ошибка: File "compiler/alpha.ml", line 16, characters 12-23: Error: Unbound module Id File "compile…
16 янв '18 в 15:55
2
ответа
Могут ли ocamldoc конструкторы ссылочного типа?
Я пытаюсь сослаться на конструктор типов в ocamldoc. Например: type x = Awesome | Boring И позже мы хотим сослаться на одного из конструкторов в некоторой документации: (** {!Awesome} is a really great constructor for {!x}. You should definitely use…
20 апр '12 в 01:55
1
ответ
Привязать ядро к ocamldoc
Я пытаюсь сгенерировать документацию для моего модуля, используя ocamldoc, Тем не менее, я использую Core библиотека и ocamldoc жалуется, что не нашел его. Error: Unbound module Core Я понимаю, почему благодаря этому вопросу, но он не упоминает ника…
21 мар '16 в 09:58
1
ответ
Ссылка на конструктор типа в ocamldoc
Я собираюсь ocamldoc предупреждения: Предупреждение: Элемент MyModule.VariantName не найден когда используешь {!MyModule.VariantName} в комментариях к документу. ocamldoc док говорит В этой главе мы используем элемент word для ссылки на любую из сле…
24 май '13 в 20:48
1
ответ
Ocamldoc "Unbound module Thread" без ocamlfind
Можно ли использовать ocamldoc для проекта с потоками без использования ocamlfind? Что важнее, как? -thread или же -package не поддерживаются ocamldoc, и -I -thread не работает
30 дек '14 в 23:03
2
ответа
Заставить ocamlbuild передавать файлы.ml и.mli в ocamldoc
Я хочу включить исходный код в мои сгенерированные документы. Это работает, когда я призываю ocamldoc в командной строке вот так: ocamldoc -I _build -html -keep-code -colorize-code *.{ml,mli} -d .docdir, Тем не менее, у меня проблемы с интеграцией э…
11 дек '12 в 20:44
1
ответ
Ocamldoc генерирует документацию для функций?
Я использую ocamldoc для генерации документации моей программы. Мой код пока не очень большой, у меня есть только одна функция, но когда я открываю HTML, документация по функциям не появляется ни в одном из файлов, созданных ocamldoc. я использую oc…
11 май '19 в 03:28
2
ответа
ocamldoc неправильно отображает имена или описание параметров с помощью @param
Проще говоря, допустим, у меня есть следующий файл OCaml с именем test.ml: (** [Test] is a sample module for showing the problem I am having with @ tags with OCamlDoc *) (** [id] is the identity function. For any argument [x], [id x] is [x]. @param …
11 ноя '20 в 04:57
1
ответ
odoc (генератор документации для OCaml) удалить префикс 'Stdlib'
Я использую odoc вместе с dune для создания документации для библиотеки. Это делается следующим образом: dune build @doc Однако это генерирует такие сигнатуры, как: val print : Stdlib.Format.formatter -> t -> unit Хотя я бы хотел: val print : …
14 янв '21 в 17:13