summaryrefslogtreecommitdiff
path: root/ocamldoc/odoc_gen.mli
diff options
context:
space:
mode:
authorMaxence Guesdon <maxence.guesdon@inria.fr>2010-08-24 09:45:45 +0000
committerMaxence Guesdon <maxence.guesdon@inria.fr>2010-08-24 09:45:45 +0000
commit0936bb2811303dba3510d476253a3653903e9f58 (patch)
tree1c17a8df5ef96f4b786ade6cb0243ffbe25783fa /ocamldoc/odoc_gen.mli
parent575555eecd11fcc745e0f1e88d090764b3291b63 (diff)
downloadocaml-0936bb2811303dba3510d476253a3653903e9f58.tar.gz
use first-class modules to allow composition of custom generators
git-svn-id: http://caml.inria.fr/svn/ocaml/trunk@10652 f963ae5c-01c2-4b8c-9fe0-0dff7051ff02
Diffstat (limited to 'ocamldoc/odoc_gen.mli')
-rw-r--r--ocamldoc/odoc_gen.mli22
1 files changed, 22 insertions, 0 deletions
diff --git a/ocamldoc/odoc_gen.mli b/ocamldoc/odoc_gen.mli
new file mode 100644
index 0000000000..1200a7c420
--- /dev/null
+++ b/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