diff options
Diffstat (limited to 'ocaml-binary-annot/ocamldoc/odoc_gen.mli')
| -rw-r--r-- | ocaml-binary-annot/ocamldoc/odoc_gen.mli | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/ocaml-binary-annot/ocamldoc/odoc_gen.mli b/ocaml-binary-annot/ocamldoc/odoc_gen.mli new file mode 100644 index 0000000000..1200a7c420 --- /dev/null +++ b/ocaml-binary-annot/ocamldoc/odoc_gen.mli @@ -0,0 +1,22 @@ +(** The types of generators. *) + +(** The minimal class type of documentation generators. *) +class type doc_generator = + object method generate : Odoc_module.t_module list -> unit end;; + +(** The module type of minimal generators. *) +module type Base = sig + class generator : doc_generator + end;; + +(** Various ways to create a generator. *) +type generator = + | Html of (module Odoc_html.Html_generator) + | Latex of (module Odoc_latex.Latex_generator) + | Texi of (module Odoc_texi.Texi_generator) + | Man of (module Odoc_man.Man_generator) + | Dot of (module Odoc_dot.Dot_generator) + | Other of (module Base) +;; + +val get_minimal_generator : generator -> doc_generator
\ No newline at end of file |