diff --git a/.gitignore b/.gitignore index 71c179e7..86bae448 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ _build *.native .session TAGS +*.docdir diff --git a/Makefile b/Makefile index 3e4b7b87..77949dbd 100644 --- a/Makefile +++ b/Makefile @@ -4,16 +4,17 @@ IMPLEMENTATION_FILES = $(shell find -name '*.ml') TARGETS_LIB = containers.cmxa containers.cma TARGET_THREAD_LIB = thread_containers.cmxa thread_containers.cma +TARGET_DOC = containers.docdir/index.html EXAMPLES = examples/mem_size.native examples/collatz.native examples/crawl.native OPTIONS = -use-ocamlfind all: lib lib_thread lib: - ocamlbuild $(OPTIONS) $(TARGETS_LIB) + ocamlbuild $(OPTIONS) $(TARGETS_LIB) $(TARGET_DOC) lib_thread: - ocamlbuild $(OPTIONS) $(TARGETS_LIB) $(TARGET_THREAD_LIB) + ocamlbuild $(OPTIONS) $(TARGETS_LIB) $(TARGET_THREAD_LIB) $(TARGET_DOC) examples: all ocamlbuild $(OPTIONS) -I . $(EXAMPLES) diff --git a/containers.odocl b/containers.odocl new file mode 100644 index 00000000..e53d5c98 --- /dev/null +++ b/containers.odocl @@ -0,0 +1,9 @@ +Deque +Future +Gen +Graph +Heap +LazyGraph +PersistentHashtbl +Sequence +Univ diff --git a/future.mli b/future.mli index af02be97..e39be681 100644 --- a/future.mli +++ b/future.mli @@ -100,7 +100,7 @@ val fail : 'a t -> exn -> unit val is_done : 'a t -> bool (** Is the future evaluated (success/failure)? *) -(** {2 Combinators *) +(** {2 Combinators} *) val on_success : 'a t -> ('a -> unit) -> unit (** Attach a handler to be called upon success *) diff --git a/lazyGraph.mli b/lazyGraph.mli index f52bb713..3790231a 100644 --- a/lazyGraph.mli +++ b/lazyGraph.mli @@ -206,7 +206,7 @@ module Infix : sig (** Union of graphs (alias for {! union}) *) end -(** {2 Pretty printing in the DOT (graphviz) format *) +(** {2 Pretty printing in the DOT (graphviz) format} *) module Dot : sig type attribute = [ | `Color of string