(***********************************************************************) (* OCamldoc *) (* *) (* Maxence Guesdon, projet Cristal, INRIA Rocquencourt *) (* *) (* Copyright 2001 Institut National de Recherche en Informatique et *) (* en Automatique. All rights reserved. This file is distributed *) (* under the terms of the Q Public License version 1.0. *) (* *) (***********************************************************************) (** The messages of the application. *) let ok = "Ok" let software = "OCamldoc" let version = "3.04-Pre4" let message_version = software^" "^version (** Messages for command line *) let usage = "Usage : "^(Sys.argv.(0))^" [options] \n" let options_are = "Options are :" let option_version = " Print version and exit" let latex_only = "(LaTeX only)" let html_only = "(HTML only)" let iso_only = "(ISO only)" let verbose_mode = " verbose mode" let include_dirs = " Add to the list of include directories" let rectypes = " Allow arbitrary recursive types" let preprocess = " Pipe sources through preprocessor " let load_file = " Load file defining a new documentation generator" let nolabels = " Ignore non-optional labels in types" let werr = "Treat ocamldoc warnings as errors" let target_dir = " Generate files in directory , rather than in current directory" let dump = " Dump collected information into " let load = " Load information from ; may be used several times" let css_style = " Use content of as CSS style definition "^html_only let index_only = " Generate index files only "^html_only let colorize_code = "Colorize code even in documentation pages "^html_only let generate_html = " Generate HTML documentation" let generate_latex = " Generate LaTeX documentation" let generate_man = " Generate man pages" let generate_iso = " Generate boring check report" let generate_dot = " Generate dot code of top modules dependencies" let default_dot_file = "dep.dot" let dot_file = " Set the file to use to output the dot code "^ "(default is "^default_dot_file^")" let dot_include_all = " include all modules in the dot output,\n"^ " not only the modules given on the command line" let dot_types = " generate dependency graph for types instead of modules" let default_dot_colors = [ "darkturquoise" ; "darkgoldenrod2" ; "cyan" ; "green" ; "magenta" ; "yellow" ; "burlywood1" ; "aquamarine" ; "floralwhite" ; "lightpink" ; "lightblue" ; "mediumturquoise" ; "salmon" ; "slategray3" ; ] let dot_colors = " use colors c1,c1,...,cn in the dot output\n"^ " (default list is "^(String.concat "," default_dot_colors)^")" let dot_reduce = " perform a transitive reduction on the selected dependency graph before the dot output\n" let option_title = " use <title> as title for the generated documentation" let with_parameter_list = " display the complete list of parameters for functions and methods "^html_only let hide_modules = " <M1,M2.M3,...> Hide the given complete module names in generated doc" let no_header = " Suppress header in generated documentation "^latex_only let no_trailer = " Suppress trailer in generated documentation "^latex_only let separate_files = " Generate one file per toplevel module "^latex_only let latex_title ref_titles = "n,style associate {n } to the given sectionning style\n"^ " (e.g. 'section') in the latex output "^latex_only^"\n"^ " Default sectionning is:\n"^ (String.concat "\n" (List.map (fun (n,t) -> Printf.sprintf " %d -> %s" n t) !ref_titles)) let no_toc = " Do not generate table of contents "^latex_only let sort_modules = " Sort the list of top modules before generating the documentation" let no_stop = " Do not stop at (**/**) comments" let no_custom_tags = " Do not allow custom @-tags" let remove_stars = " Remove beginning blanks of comment lines, until the first '*'" let keep_code = " Always keep code when available" let inverse_merge_ml_mli = "Inverse implementations and interfaces when merging" let merge_description = ('d', "merge description") let merge_author = ('a', "merge @author") let merge_version = ('v', "merge @version") let merge_see = ('l', "merge @see") let merge_since = ('s', "merge @since") let merge_deprecated = ('o', "merge @deprecated") let merge_param = ('p', "merge @param") let merge_raised_exception = ('e', "merge @raise") let merge_return_value = ('r', "merge @return") let merge_custom = ('c', "merge custom @-tags") let merge_all = ('A', "merge all") let options_can_be = " <options> can be one or more of the following characters:" let string_of_options_list l = List.fold_left (fun acc -> fun (c, m) -> acc^"\n "^(String.make 1 c)^" "^m) "" l let merge_options = "<options> specify merge options between .mli and .ml\n"^ options_can_be^ (string_of_options_list [ merge_description ; merge_author ; merge_version ; merge_see ; merge_since ; merge_deprecated ; merge_param ; merge_raised_exception ; merge_return_value ; merge_custom ; merge_all ] ) let iso_description = 'd', "description is mandatory" let iso_author = 'a', "author information is mandatory" let iso_since = 's', "@since tag is mandatory" let iso_version = 'v', "@version tag is mandatory" let iso_return = 'r', "@return tag is mandatory" let iso_params = 'p', "all named parameters must be described" let iso_fields_described = 'f', "All fields of a record type must be described" let iso_constructors_described = 'c', "All constructors of a type must be described" let iso_all = 'A', "all iso checks" let iso_base_option_list = [ iso_description ; iso_author ; iso_version ; iso_since ; iso_all ] let iso_type_options = "<options> specify iso checks to perform on each type "^iso_only^"\n"^ options_can_be^ (string_of_options_list ([iso_fields_described ; iso_constructors_described] @ iso_base_option_list)) let iso_val_met_att_options = "<options> specify iso checks to perform on each value, method or attribute "^iso_only^"\n"^ options_can_be^ (string_of_options_list (iso_params :: iso_return :: iso_base_option_list )) let iso_exception_options = "<options> specify iso checks to perform on each exception "^iso_only^"\n"^ options_can_be^ (string_of_options_list iso_base_option_list) let iso_class_options = "<options> specify iso checks to perform on each class and class type "^iso_only^"\n"^ options_can_be^ (string_of_options_list (iso_params :: iso_base_option_list)) let iso_module_options = "<options> specify iso checks to perform on each module and module type "^iso_only^"\n"^ options_can_be^ (string_of_options_list iso_base_option_list) (** Error and warning messages *) let warning = "Warning" let pwarning s = prerr_endline (warning^": "^s); if !Odoc_global.warn_error then incr Odoc_global.errors let not_a_module_name s = s^" is not a valid module name" let load_file_error f e = "Error while loading file "^f^":\n"^e^"\n" let wrong_format s = "Wrong format for \""^s^"\"" let errors_occured n = (string_of_int n)^" error(s) encountered" let parse_error = "Parse error" let text_parse_error l c s = let lines = Str.split (Str.regexp_string "\n") s in "Syntax error in text:\n"^s^"\n"^ "line "^(string_of_int l)^", character "^(string_of_int c)^":\n"^ (List.nth lines l)^"\n"^ (String.make c ' ')^"^" let tag_not_handled tag = "Tag @"^tag^" not handled by this generator" let bad_tree = "Incorrect tree structure." let not_a_valid_tag s = s^" is not a valid tag." let fun_without_param f = "Function "^f^" has no parameter.";; let method_without_param f = "Méthode "^f^" has no parameter.";; let anonymous_parameters f = "Function "^f^" has anonymous parameters." let function_colon f = "Function "^f^": " let implicit_match_in_parameter = "Parameters contain implicit pattern matching." let unknown_extension f = "Unknown extension for file "^f^"." let two_implementations name = "There are two implementations of module "^name^"." let two_interfaces name = "There are two interfaces of module "^name^"." let too_many_module_objects name = "There are two many interfaces/implementation of module "^name^"." let exception_not_found_in_implementation exc m = "Exception "^exc^" was not found in implementation of module "^m^"." let type_not_found_in_implementation exc m = "Type "^exc^" was not found in implementation of module "^m^"." let module_not_found_in_implementation m m2 = "Module "^m^" was not found in implementation of module "^m2^"." let value_not_found_in_implementation v m = "Value "^v^" was not found in implementation of module "^m^"." let class_not_found_in_implementation c m = "Class "^c^" was not found in implementation of module "^m^"." let attribute_not_found_in_implementation a c = "Attribute "^a^" was not found in implementation of class "^c^"." let method_not_found_in_implementation m c = "Method "^m^" was not found in implementation of class "^c^"." let different_types t = "Definition of type "^t^" doesn't match from interface to implementation." let attribute_type_not_found cl att = "The type of the attribute "^att^" could not be found in the signature of class "^cl^"." let method_type_not_found cl met = "The type of the method "^met^" could not be found in the signature of class "^cl^"." let module_not_found m m2 = "The module "^m2^" could not be found in the signature of module "^m^"." let module_type_not_found m mt = "The module type "^mt^" could not be found in the signature of module "^m^"." let type_not_found_in_typedtree t = "Type "^t^" was not found in typed tree." let exception_not_found_in_typedtree e = "Exception "^e^" was not found in typed tree." let module_type_not_found_in_typedtree mt = "Module type "^mt^" was not found in typed tree." let module_not_found_in_typedtree m = "Module "^m^" was not found in typed tree." let class_not_found_in_typedtree c = "Class "^c^" was not found in typed tree." let class_type_not_found_in_typedtree ct = "Class type "^ct^" was not found in typed tree." let inherit_classexp_not_found_in_typedtree n = "Inheritance class expression number "^(string_of_int n)^" was not found in typed tree." let attribute_not_found_in_typedtree att = "Class attribute "^att^" was not found in typed tree." let method_not_found_in_typedtree met = "Class method "^met^" was not found in typed tree." let cross_module_not_found n = "Module "^n^" not found" let cross_module_type_not_found n = "Module type "^n^" not found" let cross_module_or_module_type_not_found n = "Module or module type "^n^" not found" let cross_class_not_found n = "Class "^n^" not found" let cross_class_type_not_found n = "class type "^n^" not found" let cross_class_or_class_type_not_found n = "Class or class type "^n^" not found" let cross_exception_not_found n = "Exception "^n^" not found" let cross_element_not_found n = "Element "^n^" not found" let object_end = "object ... end" let struct_end = "struct ... end" let sig_end = "sig ... end" (** Messages for verbose mode. *) let analysing f = "Analysing file "^f^"..." let merging = "Merging..." let cross_referencing = "Cross referencing..." let generating_doc = "Generating documentation..." let loading f = "Loading "^f^"..." (** Messages for documentation generation.*) let modul = "Module" let modules = "Modules" let functors = "Functors" let values = "Simple values" let types = "Types" let exceptions = "Exceptions" let record = "Record" let variant = "Variant" let mutab = "mutable" let functions = "Functions" let parameters = "Parameters" let abstract = "Abstract" let functo = "Functor" let clas = "Class" let classes = "Classes" let attributes = "Attributes" let methods = "Methods" let authors = "Author(s)" let version = "Version" let since = "Since" let deprecated = "Deprecated !" let raises = "Raises" let returns = "Returns" let inherits = "Inherits" let inheritance = "Inheritance" let privat = "private" let module_type = "Module type" let class_type = "Class type" let description = "Description" let interface = "Interface" let type_parameters = "Type parameters" let class_types = "Class types" let module_types = "Module types" let see_also = "See also" let documentation = "Documentation" let index_of = "Index of" let top = "Top" let index_of_values = index_of^" values" let index_of_exceptions = index_of^" exceptions" let index_of_types = index_of^" types" let index_of_attributes = index_of^" class attributes" let index_of_methods = index_of^" class methods" let index_of_classes = index_of^" classes" let index_of_class_types = index_of^" class types" let index_of_modules = index_of^" modules" let index_of_module_types = index_of^" module types" let previous = "Previous" let next = "Next" let up = "Up" (** iso report messages *) let has_no_description n = n^" has no description." let has_no_author n = n^" has no author." let has_no_since n = n^" has no @since tag." let has_no_version n = n^" has no @version tag." let has_no_return n = n^" has no @return tag." let has_not_all_params_described n = n^" has not all its parameters described." let has_not_all_fields_described n = n^" has not all its fields described." let has_not_all_cons_described n = n^" has not all its constructors described." let value_n n = "Value "^n let type_n n = "Type "^n let exception_n n = "Exception "^n let attribute_n n = "Attribute "^n let method_n n = "Method "^n let class_n n = "Class "^n let class_type_n n = "Class type "^n let module_n n = "Module "^n let module_type_n n = "Module type "^n