diff options
| author | Maxence Guesdon <maxence.guesdon@inria.fr> | 2009-12-18 11:52:23 +0000 |
|---|---|---|
| committer | Maxence Guesdon <maxence.guesdon@inria.fr> | 2009-12-18 11:52:23 +0000 |
| commit | e904577b6b0e68911c9169eb7c1629f6f3b9534c (patch) | |
| tree | fb7538d389604e899974c0d4b2004d09a76fa7d5 /ocamldoc/odoc_types.mli | |
| parent | 758e4cd86078a89af5790872f9704c5ea019b4e7 (diff) | |
PR#4914: ability to specify a text for links to elements
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@9477 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'ocamldoc/odoc_types.mli')
| -rw-r--r-- | ocamldoc/odoc_types.mli | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/ocamldoc/odoc_types.mli b/ocamldoc/odoc_types.mli index f5b416ae5..d5d7e0e1c 100644 --- a/ocamldoc/odoc_types.mli +++ b/ocamldoc/odoc_types.mli @@ -45,8 +45,9 @@ and 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 |