retrait du génrateur iso
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@4602 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02master
Maxence Guesdon
parent
7f521cb0e8
commit
840aab2c5c
|
|
@ -110,7 +110,6 @@ EXECMOFILES=$(CMOFILES)\
|
|||
odoc_latex.cmo\
|
||||
odoc_texi.cmo\
|
||||
odoc_dot.cmo\
|
||||
odoc_iso.cmo
|
||||
|
||||
EXECMXFILES= $(EXECMOFILES:.cmo=.cmx)
|
||||
EXECMIFILES= $(EXECMOFILES:.cmo=.cmi)
|
||||
|
|
@ -262,7 +261,7 @@ odoc_crc.ml: $(CMIFILES)
|
|||
Odoc_sig Odoc_ast Odoc_control Odoc_inherit\
|
||||
Odoc_search Odoc_cross Odoc_merge Odoc_analyse\
|
||||
Odoc_dag2html Odoc_ocamlhtml Odoc_html\
|
||||
Odoc_latex Odoc_man Odoc_iso Odoc_scan > $@
|
||||
Odoc_latex Odoc_man Odoc_texi Odoc_scan > $@
|
||||
|
||||
# generic rules :
|
||||
#################
|
||||
|
|
|
|||
|
|
@ -68,14 +68,12 @@ let default_html_generator = new Odoc_html.html
|
|||
let default_latex_generator = new Odoc_latex.latex
|
||||
let default_texi_generator = new Odoc_texi.texi
|
||||
let default_man_generator = new Odoc_man.man
|
||||
let default_iso_generator = new Odoc_iso.iso
|
||||
let default_dot_generator = new Odoc_dot.dot
|
||||
let _ = Odoc_args.parse
|
||||
(default_html_generator :> Odoc_args.doc_generator)
|
||||
(default_latex_generator :> Odoc_args.doc_generator)
|
||||
(default_texi_generator :> Odoc_args.doc_generator)
|
||||
(default_man_generator :> Odoc_args.doc_generator)
|
||||
(default_iso_generator :> Odoc_args.doc_generator)
|
||||
(default_dot_generator :> Odoc_args.doc_generator)
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -24,12 +24,6 @@ let doc_generator = ref (None : doc_generator option)
|
|||
|
||||
let merge_options = ref ([] : Odoc_types.merge_option list)
|
||||
|
||||
let iso_type_options = ref ([] : Odoc_types.iso_check list)
|
||||
let iso_val_options = ref ([] : Odoc_types.iso_check list)
|
||||
let iso_exception_options = ref ([] : Odoc_types.iso_check list)
|
||||
let iso_class_options = ref ([] : Odoc_types.iso_check list)
|
||||
let iso_module_options = ref ([] : Odoc_types.iso_check list)
|
||||
|
||||
let dot_file = ref Odoc_messages.default_dot_file
|
||||
|
||||
let dot_include_all = ref false
|
||||
|
|
@ -72,24 +66,6 @@ let analyse_merge_options s =
|
|||
in
|
||||
analyse_option_string l s
|
||||
|
||||
(** Analysis of a string defining the iso checks to perform.
|
||||
Return the list of checks specified.*)
|
||||
let analyse_iso_checks s =
|
||||
let l = [
|
||||
(Odoc_messages.iso_description, [Odoc_types.Has_description]) ;
|
||||
(Odoc_messages.iso_author, [Odoc_types.Has_author]) ;
|
||||
(Odoc_messages.iso_since, [Odoc_types.Has_since]) ;
|
||||
(Odoc_messages.iso_version, [Odoc_types.Has_version]) ;
|
||||
(Odoc_messages.iso_return, [Odoc_types.Has_return]) ;
|
||||
(Odoc_messages.iso_params, [Odoc_types.Has_params]) ;
|
||||
(Odoc_messages.iso_fields_described, [Odoc_types.Has_fields_decribed]) ;
|
||||
(Odoc_messages.iso_constructors_described, [Odoc_types.Has_constructors_decribed]) ;
|
||||
(Odoc_messages.iso_all, Odoc_types.all_iso_checks)
|
||||
]
|
||||
in
|
||||
analyse_option_string l s
|
||||
|
||||
|
||||
let classic = Clflags.classic
|
||||
|
||||
let dump = ref (None : string option)
|
||||
|
|
@ -196,9 +172,6 @@ let default_texi_generator = ref (None : doc_generator option)
|
|||
(** The default man pages generator. Initialized in the parse function, to be used during the command line analysis.*)
|
||||
let default_man_generator = ref (None : doc_generator option)
|
||||
|
||||
(** The default iso check generator. Initialized in the parse function, to be used during the command line analysis.*)
|
||||
let default_iso_generator = ref (None : doc_generator option)
|
||||
|
||||
(** The default dot generator. Initialized in the parse function, to be used during the command line analysis.*)
|
||||
let default_dot_generator = ref (None : doc_generator option)
|
||||
|
||||
|
|
@ -231,7 +204,6 @@ let options = ref [
|
|||
"-latex", Arg.Unit (fun () -> set_doc_generator !default_latex_generator), Odoc_messages.generate_latex ;
|
||||
"-texi", Arg.Unit (fun () -> set_doc_generator !default_texi_generator), Odoc_messages.generate_texinfo ;
|
||||
"-man", Arg.Unit (fun () -> set_doc_generator !default_man_generator), Odoc_messages.generate_man ;
|
||||
"-iso", Arg.Unit (fun () -> set_doc_generator !default_iso_generator), Odoc_messages.generate_iso ;
|
||||
"-dot", Arg.Unit (fun () -> set_doc_generator !default_dot_generator), Odoc_messages.generate_dot ;
|
||||
"-g", Arg.String (fun s -> ()), Odoc_messages.load_file^"\n" ;
|
||||
|
||||
|
|
@ -253,13 +225,6 @@ let options = ref [
|
|||
"-noindex", Arg.Clear with_index, Odoc_messages.no_index ;
|
||||
"-esc8", Arg.Set esc_8bits, Odoc_messages.esc_8bits ;
|
||||
|
||||
(* iso only options *)
|
||||
"-iso-val", Arg.String (fun s -> iso_val_options := analyse_iso_checks s), Odoc_messages.iso_val_met_att_options ;
|
||||
"-iso-cl", Arg.String (fun s -> iso_class_options := analyse_iso_checks s), Odoc_messages.iso_class_options ;
|
||||
"-iso-mod", Arg.String (fun s -> iso_module_options := analyse_iso_checks s), Odoc_messages.iso_module_options ;
|
||||
"-iso-ex", Arg.String (fun s -> iso_exception_options := analyse_iso_checks s), Odoc_messages.iso_exception_options ;
|
||||
"-iso-ty", Arg.String (fun s -> iso_type_options := analyse_iso_checks s), Odoc_messages.iso_type_options^"\n" ;
|
||||
|
||||
(* dot only options *)
|
||||
"-dot-file", Arg.String (fun s -> dot_file := s), Odoc_messages.dot_file ;
|
||||
"-dot-colors", Arg.String (fun s -> dot_colors := Str.split (Str.regexp_string ",") s), Odoc_messages.dot_colors ;
|
||||
|
|
@ -271,12 +236,11 @@ let options = ref [
|
|||
|
||||
let add_option o = options := !options @ [o]
|
||||
|
||||
let parse ~html_generator ~latex_generator ~texi_generator ~man_generator ~iso_generator ~dot_generator =
|
||||
let parse ~html_generator ~latex_generator ~texi_generator ~man_generator ~dot_generator =
|
||||
default_html_generator := Some html_generator ;
|
||||
default_latex_generator := Some latex_generator ;
|
||||
default_texi_generator := Some texi_generator ;
|
||||
default_man_generator := Some man_generator ;
|
||||
default_iso_generator := Some iso_generator ;
|
||||
default_dot_generator := Some dot_generator ;
|
||||
let _ = Arg.parse !options
|
||||
(fun s -> files := !files @ [s])
|
||||
|
|
|
|||
|
|
@ -25,21 +25,6 @@ val doc_generator : doc_generator option ref
|
|||
(** The merge options to be used. *)
|
||||
val merge_options : Odoc_types.merge_option list ref
|
||||
|
||||
(** The iso checks to perform on each type. *)
|
||||
val iso_type_options : Odoc_types.iso_check list ref
|
||||
|
||||
(** The iso checks to perform on each value / method / attribute. *)
|
||||
val iso_val_options : Odoc_types.iso_check list ref
|
||||
|
||||
(** The iso checks to perform on each exception. *)
|
||||
val iso_exception_options : Odoc_types.iso_check list ref
|
||||
|
||||
(** The iso checks to perform on each class and class type. *)
|
||||
val iso_class_options : Odoc_types.iso_check list ref
|
||||
|
||||
(** The iso checks to perform on each module and module type. *)
|
||||
val iso_module_options : Odoc_types.iso_check list ref
|
||||
|
||||
(** Classic mode or not. *)
|
||||
val classic : bool ref
|
||||
|
||||
|
|
@ -143,7 +128,6 @@ val parse :
|
|||
latex_generator:doc_generator ->
|
||||
texi_generator:doc_generator ->
|
||||
man_generator:doc_generator ->
|
||||
iso_generator:doc_generator ->
|
||||
dot_generator:doc_generator ->
|
||||
unit
|
||||
|
||||
|
|
|
|||
|
|
@ -80,17 +80,6 @@ type location = Odoc_types.location = {
|
|||
|
||||
let dummy_loc = { loc_impl = None ; loc_inter = None }
|
||||
|
||||
type iso_check = Odoc_types.iso_check =
|
||||
| Has_description
|
||||
| Has_author
|
||||
| Has_since
|
||||
| Has_version
|
||||
| Has_return
|
||||
| Has_params
|
||||
| Has_fields_decribed
|
||||
| Has_constructors_decribed
|
||||
|
||||
|
||||
module Name = Odoc_name
|
||||
module Parameter = Odoc_parameter
|
||||
module Exception = Odoc_exception
|
||||
|
|
|
|||
|
|
@ -89,17 +89,6 @@ type location = Odoc_types.location = {
|
|||
(** A dummy location. *)
|
||||
val dummy_loc : location
|
||||
|
||||
(** The kind of checks which can be performed on elements. *)
|
||||
type iso_check = Odoc_types.iso_check =
|
||||
| Has_description (** the element has an associated description *)
|
||||
| Has_author (** the element's description has one or more \@author tag(s) *)
|
||||
| Has_since (** the element's description has a \@since tag *)
|
||||
| Has_version (** the element's description has a \@version tag *)
|
||||
| Has_return (** the function's description has a \@return tag *)
|
||||
| Has_params (** all the named parameters of the element has a description *)
|
||||
| Has_fields_decribed (** all the fields of the type are described *)
|
||||
| Has_constructors_decribed (** all the constructors of the type are described *)
|
||||
|
||||
(** Representation of element names. *)
|
||||
module Name :
|
||||
sig
|
||||
|
|
|
|||
|
|
@ -25,7 +25,6 @@ let option_version = " Print version and exit"
|
|||
let latex_only = "(LaTeX only)"
|
||||
let texi_only = "(TeXinfo only)"
|
||||
let html_only = "(HTML only)"
|
||||
let iso_only = "(ISO only)"
|
||||
let verbose_mode = " verbose mode"
|
||||
let include_dirs = "<dir> Add <dir> to the list of include directories"
|
||||
let rectypes = " Allow arbitrary recursive types"
|
||||
|
|
@ -43,7 +42,6 @@ let generate_html = " Generate HTML documentation"
|
|||
let generate_latex = " Generate LaTeX documentation"
|
||||
let generate_texinfo = " Generate TeXinfo 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"
|
||||
|
|
@ -93,7 +91,7 @@ let merge_custom = ('c', "merge custom @-tags")
|
|||
let merge_all = ('A', "merge all")
|
||||
|
||||
let no_index = " Do not build index for Info files"^texi_only
|
||||
let esc_8bits = " scape accentuated characters in Info files"^texi_only
|
||||
let esc_8bits = " scape accentuated characters in Info files"^texi_only^"\n"
|
||||
|
||||
let options_can_be = " <options> can be one or more of the following characters:"
|
||||
let string_of_options_list l =
|
||||
|
|
@ -118,37 +116,6 @@ let merge_options =
|
|||
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 *)
|
||||
|
||||
|
|
@ -276,23 +243,3 @@ 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
|
||||
|
|
|
|||
|
|
@ -25,14 +25,12 @@ let html_generator = new Odoc_html.html
|
|||
let default_latex_generator = new Odoc_latex.latex
|
||||
let default_texi_generator = new Odoc_texi.texi
|
||||
let default_man_generator = new Odoc_man.man
|
||||
let default_iso_generator = new Odoc_iso.iso
|
||||
let default_dot_generator = new Odoc_dot.dot
|
||||
let _ = Odoc_args.parse
|
||||
(html_generator :> Odoc_args.doc_generator)
|
||||
(default_latex_generator :> Odoc_args.doc_generator)
|
||||
(default_texi_generator :> Odoc_args.doc_generator)
|
||||
(default_man_generator :> Odoc_args.doc_generator)
|
||||
(default_iso_generator :> Odoc_args.doc_generator)
|
||||
(default_dot_generator :> Odoc_args.doc_generator)
|
||||
|
||||
let loaded_modules =
|
||||
|
|
|
|||
|
|
@ -133,25 +133,3 @@ let all_merge_options = [
|
|||
Merge_custom ;
|
||||
]
|
||||
|
||||
(** The kind of checks which can be performed on elements. *)
|
||||
type iso_check =
|
||||
| Has_description (** the element has an associated description *)
|
||||
| Has_author (** the element's description has one or more \@author tag(s) *)
|
||||
| Has_since (** the element's description has a \@since tag *)
|
||||
| Has_version (** the element's description has a \@version tag *)
|
||||
| Has_return (** the function's description has a \@return tag *)
|
||||
| Has_params (** all the named parameters of the element has a description *)
|
||||
| Has_fields_decribed (** all the fields of the type are described *)
|
||||
| Has_constructors_decribed (** all the constructors of the type are described *)
|
||||
|
||||
(** The list of all checks. *)
|
||||
let all_iso_checks = [
|
||||
Has_description ;
|
||||
Has_author ;
|
||||
Has_since ;
|
||||
Has_version ;
|
||||
Has_return ;
|
||||
Has_params ;
|
||||
Has_fields_decribed ;
|
||||
Has_constructors_decribed ;
|
||||
]
|
||||
|
|
|
|||
Loading…
Reference in New Issue