doc: add documentation based on D3.js wiki

Author: seliopou

.gitignore

@@ -1,5 +1,6 @@
 .*.sw[po]
 _build/
+d3.docdir
 setup.log
 setup.data
 *.native

_oasis

@@ -20,6 +20,14 @@ Library d3
   Modules:      D3
   BuildDepends: js_of_ocaml, js_of_ocaml.syntax
 
+Document d3
+  Title:                D3 Docs
+  Type:                 ocamlbuild (0.4)
+  BuildTools+:          ocamldoc
+  Install:              true
+  XOCamlbuildPath:      lib
+  XOCamlbuildLibraries: d3
+
 Executable rectangle
   Path:             examples
   MainIs:           rectangle.ml

lib/d3.mli

@@ -31,48 +31,225 @@
     POSSIBILITY OF SUCH DAMAGE.
   ----------------------------------------------------------------------------*)
 
+(** js_of_ocaml bindings for the D3.js library. *)
+
 type ('a, 'b) t
+(** The type of a D3 operation that assumes that its parent has data of type
+    ['a] bound to it, and which itself can act as a context with data of type
+    ['b] bound to it. *)
+
 type ('a, 'b) fn = Dom.node Js.t -> 'a -> int -> 'b
+(** A type alias for the sorts of functions that can be used to construct
+    {!attr}, {!classed}, {!style}, and {!property}, selections below. *)
+
+val select : string -> ('a, 'a) t
+(** [select selector] selects the first descendant element that matches the
+    specified selector string, for each element in the selection. If the
+    current element has associated data, this data is inherited by the returned
+    subselection, and automatically bound to the newly selected elements. If
+    multiple elements match the selector, only the first matching element in
+    document traversal order will be selected.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#select}D3.js docs} *)
 
-val select    : string -> ('a, 'a) t
 val selectAll : string -> ('a, 'a) t
+(** [selectAll selector] selects descendant elements that match the specified
+    selector string, for each element in the selection. The subselection does
+    not inherit data from the current selection; however, if the data value is
+    specified as a function, this function will be called with the data d of the
+    ancestor node and the group index i to determine the data bindings for the
+    subselection.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#selectAll}D3.js docs} *)
+
+val attr : string -> ('a, string) fn -> ('a, 'a) t
+(** [attr name f] sets the [name] attribute to the specified value on all
+    selected elements. The value is determined by calling [f] for each element,
+    passing it the current DOM element, the datum attached to the DOM element,
+    and the element's index in the selection.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#attr}D3.js docs} *)
+
+val classed : string -> ('a, bool) fn -> ('a, 'a) t
+(** [classed class f] sets whether or not [class] is associated with the
+    selected elements. This is determined by calling [f] for each element,
+    passing it the current DOM element, the datum attached to the DOM element,
+    and the element's index in the selection.
+
+    This operator is a convenience routine for setting the ["class"] attribute;
+    it understands that the ["class"] attribute is a set of tokens separated by
+    spaces. If you want to set several classes at once use a space-separated
+    list of class names as the first argument.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#classes}D3.js docs} *)
+
+val style : string -> ('a, string) fn -> ('a, 'a) t
+(** [style name f] sets the [name] CSS style property to the specified value on
+    all selected elements. The value is determined by calling [f] for each element,
+    passing it the current DOM element, the datum attached to the DOM element,
+    and the element's index in the selection.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#style}D3.js docs} *)
 
-val attr     : string -> ('a, string  ) fn -> ('a, 'a) t
-val classed  : string -> ('a, bool    ) fn -> ('a, 'a) t
-val style    : string -> ('a, string  ) fn -> ('a, 'a) t
 val property : string -> ('a, 'b Js.t ) fn -> ('a, 'a) t
+(** [property name f] sets the [name] property to the specified value on all
+    selected elements. The value is determined by calling [f] for each element,
+    passing it the current DOM element, the datum attached to the DOM element,
+    and the element's index in the selection.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#property}D3.js docs} *)
 
 val text : ('a, string) fn -> ('a, 'a) t
+(** [text f] sets the text content to the specified value on all selected
+    elements. The value is determined by calling [f] for each element, passing
+    it the current DOM element, the datum attached to the DOM element, and the
+    element's index in the selection.
+
+    The [text] operator is based on the
+    {{:http://www.w3.org/TR/DOM-Level-3-Core/core.html#Node3-textContent}textContent}
+    property; setting the text content will replace any existing child elements.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#text}D3.js docs} *)
+
 val html : ('a, string) fn -> ('a, 'a) t
+(** [html f] sets the inner HTML content to the specified value on all selected
+    elements. The value is determined by calling [f] for each element, passing
+    it the current DOM element, the datum attached to the DOM element, and the
+    element's index in the selection.
+
+    The [html] operator is based on the
+    {{:http://dev.w3.org/html5/spec-LC/apis-in-html-documents.html#innerhtml}innerHTML}
+    property; setting the inner HTML content will replace any existing child
+    elements. Also, you may prefer to use the {!append} operator to create HTML
+    content in a data-driven way; this operator is intended for when you want a
+    little bit of HTML, say for rich formatting.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#html}D3.js docs} *)
 
 val append : string -> ('a, 'a) t
-val static : string -> ('a, 'a) t
+(** [append name] appends a new [name] element as the last child of each
+    element in the current selection, returning a new selection containing the
+    appended elements. Each new element inherits the data of the current
+    elements in the same manner as {!select}.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#append}D3.js docs} *)
+
 val remove : ('a, 'a) t
+(** [remove] removes the elements in the current selection from the current
+    document. Returns the current selection (the same elements that were
+    removed) which are now "off-screen", detached from the DOM.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#remove}D3.js docs} *)
+
+val static : string -> ('a, 'a) t
+(** [static name] appends a new [name] element as the last child of each
+    element in the current selection, if [name] child element does not already
+    exist. If an [name] element already does exist, then it will return a
+    selection containing just that element.
+
+    Note that you can use multiple [static] operators to create elements with
+    the same name.
+
+{[nest (select "body")
+  [ static "div"
+    |. text (fun _ _ _ -> "first div")
+  ; static "div"
+    |. text (fun _ _ _ -> "second div") ] ]}
+
+    This is not part of the D3.js API. *)
+
+(** {2 Data Binding} *)
 
-val datum : ('a -> int -> 'b list) -> ('a, 'b) t
 val data  : ('a -> int -> 'b list) -> ('a, 'b) t
+(** {{:https://github.com/mbostock/d3/wiki/Selections#data}D3.js docs} *)
+
+val datum : ('a -> int -> 'b list) -> ('a, 'b) t
+(** {{:https://github.com/mbostock/d3/wiki/Selections#datum}D3.js docs} *)
+
+val enter : ('a, 'a) t
+(** [enter] returns the enter selection: placeholder nodes for each data
+    element for which no corresponding existing DOM element was found in the
+    current selection. This operation can only be composed below an update
+    selection, which is produced by the {!data} operator.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#enter}D3.js docs} *)
 
-val enter  : ('a, 'a) t
 val update : ('a, 'a) t
-val exit   : ('a, 'a) t
+(** [update] is a NOOP operation. It leaves the parent selection unchanged and
+    has no side-effects.
+
+    This is not part of the D3.js API. *)
+
+val exit : ('a, 'a) t
+(** [exit] returns the exit selection: existing DOM elements in the current
+    selection for which no new data element was found. This operation can only
+    be composed below an update selection, which is produced by the {!data}
+    operator.
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#exit}D3.js docs} *)
+
+(** {2 Selection manipulation} *)
 
 val filter : ('a, bool) fn -> ('a, 'a) t
+(** [filter f] returns a new selection that contains only the elements for
+    which [f] evaluates to [true].
+
+    {{:https://github.com/mbostock/d3/wiki/Selections#filter}D3.js docs} *)
+
 val sort   : ('a -> 'a -> int) -> ('a, 'a) t
+(** [sort f] sorts the elements in the current selection according to the
+    comparator function, and then re-inserts the document elements to match.
+
+   {{:https://github.com/mbostock/d3/wiki/Selections#sort}D3.js docs} *)
+
+(** {2 Composition operators} *)
 
 val (|.)  : ('a, 'b) t -> ('b, 'c) t -> ('a, 'c) t
 val (<.>) : ('a, 'b) t -> ('b, 'c) t -> ('a, 'c) t
+(** [x |. y] is the equivalent of method chaining operators [x] and [y] in
+    JavaScript. [<.>] is an alias for [|.]. *)
+
 val (|-)  : ('a, 'b) t -> ('b, 'c) t -> ('a, 'b) t
 
 val chain : ('a, 'a) t list -> ('a, 'a) t
 val seq   : ('a, 'a) t list -> ('a, 'a) t
+
 val nest  : ('a, 'b) t -> ('b, 'b) t list -> ('a, 'b) t
+(** [nest x ys] is equivalent to [x |- seq ys]. *)
+
+(** {2 Casting} *)
 
 val str : (string -> ('a, string) fn -> ('a, 'a) t) -> string -> string -> ('a, 'a) t
 val int : (string -> ('a, string) fn -> ('a, 'a) t) -> string -> int    -> ('a, 'a) t
 val flt : (string -> ('a, string) fn -> ('a, 'a) t) -> string -> float  -> ('a, 'a) t
+(** [str attr x y] will set the [x] attribute to the constant string value [y].
+    The [int] and [flt] functions do the same thing except with constant values
+    of different types. These convenience functions should be used with the
+    {!attr}, and {!style} functions when dealing with constant values. That way
+    you can write code like this:
+
+{[selectAll "rect"
+|. int attr  "height" height
+|. int attr  "width"  height
+|. str style "fill"   "blue"]}
+
+    rather than this:
 
+{[selectAll "rect"
+|. attr  "height" (fun _ _ _ -> string_of_int height)
+|. attr  "width"  (fun _ _ _ -> string_of_int width)
+|. style "fill"   (fun _ _ _ -> "blue")]} *)
+
+
+(** Event handlers *)
 module E : sig
   type ('event, 'a) handler = 'event Js.t -> 'a -> int -> unit
+  (** The type of an event handler. The handler expects an event of type
+      ['event] that it can interact with via the js_of_ocaml API, as well as
+      data of type ['a] to be associated with the DOM node that produced the
+      event. *)
+
+  (** {2 Mouse events} *)
 
   val click       : (Dom_html.mouseEvent, 'a) handler -> ('a, 'a) t
   val dblclick    : (Dom_html.mouseEvent, 'a) handler -> ('a, 'a) t
@@ -82,10 +259,14 @@ module E : sig
   val mousemove   : (Dom_html.mouseEvent, 'a) handler -> ('a, 'a) t
   val mouseout    : (Dom_html.mouseEvent, 'a) handler -> ('a, 'a) t
 
+  (** {2 Keyboard events} *)
+
   val keypress    : (Dom_html.keyboardEvent, 'a) handler -> ('a, 'a) t
   val keydown     : (Dom_html.keyboardEvent, 'a) handler -> ('a, 'a) t
   val keyup       : (Dom_html.keyboardEvent, 'a) handler -> ('a, 'a) t
 
+  (** {2 Drag-and-drop events} *)
+
   val dragstart   : (Dom_html.dragEvent, 'a) handler -> ('a, 'a) t
   val dragend     : (Dom_html.dragEvent, 'a) handler -> ('a, 'a) t
   val dragenter   : (Dom_html.dragEvent, 'a) handler -> ('a, 'a) t
@@ -94,6 +275,8 @@ module E : sig
   val drag        : (Dom_html.dragEvent, 'a) handler -> ('a, 'a) t
   val drop        : (Dom_html.dragEvent, 'a) handler -> ('a, 'a) t
 
+  (** {2 Miscellaneous events} *)
+
   val input       : (Dom_html.event, 'a) handler -> ('a, 'a) t
   val timeupdate  : (Dom_html.event, 'a) handler -> ('a, 'a) t
   val change      : (Dom_html.event, 'a) handler -> ('a, 'a) t
@@ -105,7 +288,24 @@ module E : sig
   val select      : (Dom_html.event, 'a) handler -> ('a, 'a) t
   val mousewheel  : (Dom_html.event, 'a) handler -> ('a, 'a) t
 
+  (** {2 Generic events} *)
+
   val handle : string -> (Dom_html.event, 'a) handler -> ('a, 'a) t
 end
 
 val run : string -> 'a -> ('a, _) t -> unit
+(** [run selector datum op] selects the first element that matches [selector],
+    binds [datum] to it, and runs [op] on that element. This is the only way to
+    run a D3.t operation. It can be used in a variety of contexts, however its
+    indended use is in an event loop of an application, along these lines:
+
+{[
+let main () =
+  let model = ref Model.init in
+  D3.run "body" !model view;
+  Stream.iter events (fun e ->
+    model := handle e model;
+    D3.run "body" !model view)
+;;
+
+main ()]}*)

lib/d3.odocl

@@ -0,0 +1,4 @@
+# OASIS_START
+# DO NOT EDIT (digest: a3deb6e481689f1d3303caecb8a6c401)
+D3
+# OASIS_STOP

opam/opam

@@ -19,6 +19,7 @@ build-test: [
   ["ocaml" "setup.ml" "-build"]
   ["ocaml" "setup.ml" "-test"]
 ]
+build-doc: [ "ocaml" "setup.ml" "-doc" ]
 depends: [
   "js_of_ocaml"
   "ocamlfind" {build}