Могут ли ocamldoc конструкторы ссылочного типа?

Я пытаюсь сослаться на конструктор типов в ocamldoc.

Например:

type x = Awesome | Boring

И позже мы хотим сослаться на одного из конструкторов в некоторой документации:

(** {!Awesome} is a really great constructor for {!x}.  You should definitely use it instead of {!Boring}. *)

ocamldoc жалуется:

Warning: Element Awesome not found
Warning: Element Boring not found

Есть ли способ ссылаться на конструкторы типов так, чтобы ocamldoc мог ссылаться на соответствующий тип?

2 ответа

Решение

Вы не можете напрямую ссылаться на конструктор типа. Тем не менее, вы можете ссылаться на сам тип:

(** {{!x}Awesome} is a really great constructor for {!x}. *)

Если вы хотите что-то более точное, вы можете написать небольшой плагин ocamldoc, чтобы перезаписать html_of_Ref метод.

AFAIK это не возможно. Вы можете увидеть вид ссылок, которые могут быть сделаны с этим синтаксисом здесь. Однако то, что вы можете сделать, это:

(** {{!x}[Awesome]} that will at least bring to {!x} by clicking on it. *)
Другие вопросы по тегам