diff options
Diffstat (limited to 'ocamldoc/odoc_info.mli')
| -rw-r--r-- | ocamldoc/odoc_info.mli | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/ocamldoc/odoc_info.mli b/ocamldoc/odoc_info.mli index 97c44db91..63e3ba23f 100644 --- a/ocamldoc/odoc_info.mli +++ b/ocamldoc/odoc_info.mli @@ -45,8 +45,10 @@ and text_element = Odoc_types.text_element = (** Style number, optional label, and text. *) | Latex of string (** A string for latex. *) | Link of string * text (** A reference string and the link text. *) - | Ref of string * ref_kind option - (** A reference to an element. Complete name and kind. *) + | Ref of string * ref_kind option * text option + (** A reference to an element. Complete name and kind. + An optional text can be given to display this text instead + of the element name.*) | Superscript of text (** Superscripts. *) | Subscript of text (** Subscripts. *) | Module_list of string list |