target for documentation of some modules

This commit is contained in:
Simon Cruanes 2013-04-03 00:01:52 +02:00
parent 0a58a380d8
commit 85b3ca233b
5 changed files with 15 additions and 4 deletions

1
.gitignore vendored
View file

@ -4,3 +4,4 @@ _build
*.native *.native
.session .session
TAGS TAGS
*.docdir

View file

@ -4,16 +4,17 @@ IMPLEMENTATION_FILES = $(shell find -name '*.ml')
TARGETS_LIB = containers.cmxa containers.cma TARGETS_LIB = containers.cmxa containers.cma
TARGET_THREAD_LIB = thread_containers.cmxa thread_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 EXAMPLES = examples/mem_size.native examples/collatz.native examples/crawl.native
OPTIONS = -use-ocamlfind OPTIONS = -use-ocamlfind
all: lib lib_thread all: lib lib_thread
lib: lib:
ocamlbuild $(OPTIONS) $(TARGETS_LIB) ocamlbuild $(OPTIONS) $(TARGETS_LIB) $(TARGET_DOC)
lib_thread: lib_thread:
ocamlbuild $(OPTIONS) $(TARGETS_LIB) $(TARGET_THREAD_LIB) ocamlbuild $(OPTIONS) $(TARGETS_LIB) $(TARGET_THREAD_LIB) $(TARGET_DOC)
examples: all examples: all
ocamlbuild $(OPTIONS) -I . $(EXAMPLES) ocamlbuild $(OPTIONS) -I . $(EXAMPLES)

9
containers.odocl Normal file
View file

@ -0,0 +1,9 @@
Deque
Future
Gen
Graph
Heap
LazyGraph
PersistentHashtbl
Sequence
Univ

View file

@ -100,7 +100,7 @@ val fail : 'a t -> exn -> unit
val is_done : 'a t -> bool val is_done : 'a t -> bool
(** Is the future evaluated (success/failure)? *) (** Is the future evaluated (success/failure)? *)
(** {2 Combinators *) (** {2 Combinators} *)
val on_success : 'a t -> ('a -> unit) -> unit val on_success : 'a t -> ('a -> unit) -> unit
(** Attach a handler to be called upon success *) (** Attach a handler to be called upon success *)

View file

@ -206,7 +206,7 @@ module Infix : sig
(** Union of graphs (alias for {! union}) *) (** Union of graphs (alias for {! union}) *)
end end
(** {2 Pretty printing in the DOT (graphviz) format *) (** {2 Pretty printing in the DOT (graphviz) format} *)
module Dot : sig module Dot : sig
type attribute = [ type attribute = [
| `Color of string | `Color of string