OK - fix: useless parenthesis around agruments of arguments of a type constructor in

     type definitions, and aournd arguments of exceptions in exception definitions.
OK - fix: blank lines in verbatim, latex, code pre, code and ele ref modes
     are now accepted


git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@6162 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02

Author: zoggy

ocamldoc/Changes.txt

@@ -1,5 +1,23 @@
 Current :
-OK - add: new option -customdir
+OK - fix: useless parenthesis around agruments of arguments of a type constructor in
+     type definitions, and aournd arguments of exceptions in exception definitions.
+OK - fix: blank lines in verbatim, latex, code pre, code and ele ref modes
+     are now accepted
+OK - fix: html generator: included module names were displayed with their simple
+     name rather than their fully qualified name
+OK - fix: use a formatter from a buffer rather Format.str_formatter in
+     Odoc_mist.sting_of_module_type, to avoid too much blanks
+OK - new module odoc_print, will work when Format.pp_print_flush is fixed
+OK - odoc_html: use buffers instead of string concatenation
+OK - odoc_man: use buffers instead of string concatenation
+OK - odoc_cross.ml: use hash tables modified on the fly to resolve 
+    (module | module type | exception) name aliases
+OK - odoc_html: replace some calls to Str. by specific functions on strings
+OK - odoc_cross.ml: use a Map to associate a complete name to
+    the known elements with this name, instead of searching each time
+    through the whole list of modules -> a gain of more than 90% in speed
+    for cross-referecing (Odoc_cross.associate)
+OK - fix: Odoc_name.cut printed a '(' instead of a '.' OK - add: new option -customdir
 OK - add: new option -i (to add a path to the directory where 
      to look for custom generators)
 OK - add: add odoc_config.ml{,i}
@@ -20,23 +38,11 @@ OK - add: field m_code for modules, to keep the code of top modules
 OK - fix: display "include Foo" instead of "include module Foo" in Latex, Man, Texi
 OK - fix: not display comments associated to include directives
 OK - fix: bad display of type parameters for class and class types
-- need to fix display of type parameters for inherited classes/class types
-OK - fix: html generator: included module names were displayed with their simple
-     name rather than their fully qualified name
-OK - fix: use a formatter from a buffer rather Format.str_formatter in
-     Odoc_mist.sting_of_module_type, to avoid too much blanks
-OK - new module odoc_print, will work when Format.pp_print_flush is fixed
-  - odoc_html: use buffers instead of string concatenation
-OK - odoc_man: use buffers instead of string concatenation
-  - odoc_latex: use buffers instead of string concatenation
-OK - odoc_cross.ml: use hash tables modified on the fly to resolve 
-    (module | module type | exception) name aliases
-OK - odoc_html: replace some calls to Str. by specific functions on strings
-OK - odoc_cross.ml: use a Map to associate a complete name to
-    the known elements with this name, instead of searching each time
-    through the whole list of modules -> a gain of more than 90% in speed
-    for cross-referecing (Odoc_cross.associate)
-OK - fix: Odoc_name.cut printed a '(' instead of a '.' 
+
+TODO:
+ - need to fix display of type parameters for inherited classes/class types
+ - odoc_latex: use buffers instead of string concatenation
+
 
 
 ======

ocamldoc/odoc_html.ml

@@ -994,9 +994,9 @@ class html =
       bs b "</code>"
 
     (** Print html code to display a [Types.type_expr list]. *)
-    method html_of_type_expr_list b m_name sep l =
+    method html_of_type_expr_list ?par b m_name sep l =
       print_DEBUG "html#html_of_type_expr_list";
-      let s = Odoc_info.string_of_type_list sep l in
+      let s = Odoc_info.string_of_type_list ?par sep l in
       print_DEBUG "html#html_of_type_expr_list: 1";
       let s2 = newline_to_indented_br s in
       print_DEBUG "html#html_of_type_expr_list: 2";
@@ -1081,7 +1081,8 @@ class html =
          [] -> ()
        | _ -> 
            bs b (" "^(self#keyword "of")^" ");
-           self#html_of_type_expr_list b (Name.father e.ex_name) " * " e.ex_args
+           self#html_of_type_expr_list 
+	     ~par: false b (Name.father e.ex_name) " * " e.ex_args
       );
       (
        match e.ex_alias with
@@ -1149,7 +1150,7 @@ class html =
                [] -> ()
              | l -> 
 		 bs b (" " ^ (self#keyword "of") ^ " ");
-		 self#html_of_type_expr_list b father " * " l;
+		 self#html_of_type_expr_list ~par: false b father " * " l;
             );
             bs b "</code></td>\n";
             (

ocamldoc/odoc_info.ml

@@ -117,7 +117,7 @@ let string_of_variance t (co,cn) = Odoc_str.string_of_variance t (co, cn)
 
 let string_of_type_expr t = Odoc_print.string_of_type_expr t
 
-let string_of_type_list sep type_list = Odoc_str.string_of_type_list sep type_list
+let string_of_type_list ?par sep type_list = Odoc_str.string_of_type_list ?par sep type_list
 
 let string_of_type_param_list t = Odoc_str.string_of_type_param_list t
 

ocamldoc/odoc_info.mli

@@ -618,15 +618,15 @@ val string_of_type_expr : Types.type_expr -> string
 
 (** This function returns a string to represent the given list of types,
    with a given separator. *)
-val string_of_type_list : string -> Types.type_expr list -> string
+val string_of_type_list : ?par: bool -> string -> Types.type_expr list -> string
 
 (** This function returns a string to represent the list of type parameters
    for the given type. *)
 val string_of_type_param_list : Type.t_type -> string
 
 (** This function returns a string to represent the given list of 
    type parameters of a class or class type,
-   with a given separator. It writes in and flushes [Format.str_formatter].*)
+   with a given separator. *)
 val string_of_class_type_param_list : Types.type_expr list -> string
 
 (** This function returns a string representing a [Types.module_type]. 

ocamldoc/odoc_latex.ml

@@ -447,7 +447,7 @@ class latex =
                        | l -> 
                            Format.fprintf Format.str_formatter " %s@ %s" 
 			     "of"
-                             (self#normal_type_list mod_name " * " l)
+                             (self#normal_type_list ~par: false mod_name " * " l)
 		      );
 		      Format.flush_str_formatter ()
                     in

ocamldoc/odoc_man.ml

@@ -311,8 +311,8 @@ class man =
       bs b "\n"
 
     (** Print groff string to display a [Types.type_expr list].*)
-    method man_of_type_expr_list b m_name sep l =
-      let s = Odoc_str.string_of_type_list sep l in
+    method man_of_type_expr_list ?par b m_name sep l =
+      let s = Odoc_str.string_of_type_list ?par sep l in
       let s2 = Str.global_replace (Str.regexp "\n") "\n.B " s in
       bs b "\n.B ";
       bs b (self#relative_idents m_name s2);
@@ -361,7 +361,9 @@ class man =
          [] -> ()
        | _ -> 
            bs b ".B of ";
-           self#man_of_type_expr_list b (Name.father e.ex_name) " * " e.ex_args
+           self#man_of_type_expr_list 
+	     ~par: false
+	     b (Name.father e.ex_name) " * " e.ex_args
       );
       (
        match e.ex_alias with
@@ -418,11 +420,11 @@ class man =
 		   bs b " *)\n "
                | l, None -> 
                    bs b "\n.B of ";
-		   self#man_of_type_expr_list b father " * " l;
+		   self#man_of_type_expr_list ~par: false b father " * " l;
 		   bs b " "
                | l, (Some t) ->
                    bs b "\n.B of ";
-		   self#man_of_type_expr_list b father " * " l;
+		   self#man_of_type_expr_list ~par: false b father " * " l;
                    bs b ".I \"  \"\n";
                    bs b "(* ";
 		   self#man_of_text b t;

ocamldoc/odoc_str.ml

@@ -69,11 +69,14 @@ let raw_string_of_type_list sep type_list =
   Format.pp_print_flush fmt ();
   Buffer.contents buf
 
-let string_of_type_list sep type_list =
+let string_of_type_list ?par sep type_list =
   let par =
-    match type_list with
-      [] | [_] -> false
-    | _ -> true
+    match par with
+    | Some b -> b
+    | None ->
+	match type_list with
+	  [] | [_] -> false
+	| _ -> true
   in
   Printf.sprintf "%s%s%s"
     (if par then "(" else "")

ocamldoc/odoc_str.mli

@@ -17,16 +17,18 @@
 val string_of_variance : Odoc_type.t_type -> (bool * bool) -> string
 
 (** This function returns a string to represent the given list of types,
-   with a given separator. It writes in and flushes [Format.str_formatter].*)
-val string_of_type_list : string -> Types.type_expr list -> string
+   with a given separator.
+   @param par can be used to force the addition or not of parentheses around the returned string.
+*)
+val string_of_type_list : ?par: bool -> string -> Types.type_expr list -> string
 
 (** This function returns a string to represent the list of type parameters
-   for the given type. It writes in and flushes [Format.str_formatter].*)
+   for the given type. *)
 val string_of_type_param_list : Odoc_type.t_type -> string
 
 (** This function returns a string to represent the given list of 
    type parameters of a class or class type,
-   with a given separator. It writes in and flushes [Format.str_formatter].*)
+   with a given separator. *)
 val string_of_class_type_param_list : Types.type_expr list -> string
 
 (** @return a string to describe the given type. *)

ocamldoc/odoc_text_lexer.mll

@@ -708,7 +708,10 @@ rule main = parse
          END_SHORTCUT_LIST
         )
       else
-        BLANK_LINE
+	if !latex_mode or (!open_brackets >= 1) or !code_pre_mode or !ele_ref_mode or !verb_mode then
+	  Char (Lexing.lexeme lexbuf)
+	else
+          BLANK_LINE
     } 
 
 | eof           { EOF }

ocamldoc/odoc_to_text.ml

@@ -201,8 +201,8 @@ class virtual to_text =
       (self#relative_idents m_name (Odoc_info.string_of_type_expr t))
 
     (** Get a string for a list of types where all idents are relative. *)
-    method normal_type_list m_name sep t =
-      (self#relative_idents m_name (Odoc_info.string_of_type_list sep t))
+    method normal_type_list ?par m_name sep t =
+      (self#relative_idents m_name (Odoc_info.string_of_type_list ?par sep t))
 
     (** Get a string for a list of class or class type type parameters
        where all idents are relative. *)
@@ -296,7 +296,9 @@ class virtual to_text =
         | _ -> 
             Format.fprintf Format.str_formatter "@ of "
         );
-      let s = self#normal_type_list (Name.father e.ex_name) " * " e.ex_args in
+      let s = self#normal_type_list 
+	  ~par: false (Name.father e.ex_name) " * " e.ex_args 
+      in
       let s2 = 
         Format.fprintf Format.str_formatter "%s" s ;
         (match e.ex_alias with