summaryrefslogtreecommitdiffstats
path: root/ocamldoc/odoc_misc.mli
diff options
context:
space:
mode:
authorDamien Doligez <damien.doligez-inria.fr>2004-08-20 17:04:35 +0000
committerDamien Doligez <damien.doligez-inria.fr>2004-08-20 17:04:35 +0000
commitc3a39fc8c84698aa4985c779e16493c2409a0285 (patch)
tree0454ddf1543d0f6a78f9b6d6fff79ae8080f48e1 /ocamldoc/odoc_misc.mli
parent8030a20089b6ed8a7b654c189f00a6f3693f8bce (diff)
Fusion des modifs de la branche release308 entre 3.08.0 et 3.08.1
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@6612 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'ocamldoc/odoc_misc.mli')
-rw-r--r--ocamldoc/odoc_misc.mli7
1 files changed, 7 insertions, 0 deletions
diff --git a/ocamldoc/odoc_misc.mli b/ocamldoc/odoc_misc.mli
index 982def9db..2acedb2cb 100644
--- a/ocamldoc/odoc_misc.mli
+++ b/ocamldoc/odoc_misc.mli
@@ -75,6 +75,10 @@ val first_sentence_and_rest_of_text :
(** Return the given [text] without any title or list. *)
val text_no_title_no_list : Odoc_types.text -> Odoc_types.text
+(** [concat sep l] concats the given list of text [l], each separated with
+ the text [sep]. *)
+val text_concat : Odoc_types.text -> Odoc_types.text list -> Odoc_types.text
+
(** Return the list of titles in a [text].
A title is a title level, an optional label and a text.*)
val get_titles_in_text : Odoc_types.text -> (int * string option * Odoc_types.text) list
@@ -86,6 +90,9 @@ val get_titles_in_text : Odoc_types.text -> (int * string option * Odoc_types.te
begin with a letter should be in the first returned list.*)
val create_index_lists : 'a list -> ('a -> string) -> 'a list list
+(** [remove_ending_newline s] returns [s] without the optional ending newline. *)
+val remove_ending_newline : string -> string
+
(** Take a type and remove the option top constructor. This is
useful when printing labels, we we then remove the top option contructor
for optional labels.*)