Module `Ocamlary`

This is an interface with all of the module system features. This documentation demonstrates:

comment formatting
unassociated comments
documentation sections
module system documentation including
1. submodules
2. module aliases
3. module types
4. module type aliases
5. modules with signatures
6. modules with aliased signatures

A numbered list:

David Sheets is the author.

author David Sheets

You may find more information about this HTML documentation renderer at github.com/dsheets/ocamlary.

This is some verbatim text:

verbatim

This is some verbatim text:

[][df[]]}}

Here is some raw LaTeX:

Here is an index table of Empty modules:

Empty A plain, empty module
EmptyAlias A plain module alias of Empty

Odoc doesn't support {!indexlist}.

Here is some superscript: x²

Here is some subscript: x₀

Here are some escaped brackets: { [ @ ] }

Here is some emphasis followed by code.

An unassociated comment

Level 1

Level 2

Level 3

Level 4

Basic module stuff

module Empty : sig ... end

A plain, empty module

module type Empty = sig ... end

An ambiguous, misnamed module type

module type MissingComment = sig ... end

An ambiguous, misnamed module type

Section 9000

module EmptyAlias = Ocamlary.Empty

A plain module alias of Empty

EmptySig

module type EmptySig = sig ... end

A plain, empty module signature

module type EmptySigAlias = Ocamlary.EmptySig

A plain, empty module signature alias of

module ModuleWithSignature : Ocamlary.EmptySig

A plain module of a signature of EmptySig (reference)

module ModuleWithSignatureAlias : Ocamlary.EmptySigAlias

A plain module with an alias signature

module One : sig ... end

module type SigForMod = sig ... end

There's a signature in a module in this signature.

module type SuperSig = sig ... end

For a good time, see A Labeled Section Header Inside of a Signature or Another Labeled Section Header Inside of a Signature or SuperSig.EmptySig. Section Section 9000 is also interesting. EmptySig is the section and EmptySig is the module signature.

module Buffer : sig ... end

References are resolved after everything, so {!Buffer.t} won't resolve.

Some text before exception title.

Basic exception stuff

After exception title.

exception Kaboom of unit

Unary exception constructor

exception Kablam of unit * unit

Binary exception constructor

exception Kapow of unit * unit

Unary exception constructor over binary tuple

exception EmptySig

EmptySig is a module and EmptySig is this exception.

exception EmptySigAlias

EmptySigAlias is this exception.

Basic type and value stuff with advanced doc comments

type ('a, 'b) a_function = 'a -> 'b

a_function is this type and a_function is the value below.

val a_function : x:int -> int

This is a_function with param and return type.

parameter x
the x coordinate

returns
the y coordinate

val fun_fun_fun : 
  ((int, int) Ocamlary.a_function, (unit, unit) Ocamlary.a_function)
    Ocamlary.a_function

val fun_maybe : ?yes:unit -> unit -> int

val not_found : unit -> unit

raises Not_found
That's all it does

val kaboom : unit -> unit

raises Kaboom
That's all it does

val ocaml_org : string

see http://ocaml.org/
The OCaml Web site

val some_file : string

see some_file
The file called some_file

val some_doc : string

see some_doc
The document called some_doc

val since_mesozoic : unit

This value was introduced in the Mesozoic era.

since mesozoic

val changing : unit

This value has had changes in 1.0.0, 1.1.0, and 1.2.0.

before 1.0.0
before 1.0.0

before 1.1.0
before 1.1.0

version 1.2.0

Some Operators

val (~-) : unit

val (!) : unit

val (@) : unit

val ($) : unit

val (%) : unit

val (&) : unit

val (*) : unit

val (-) : unit

val (+) : unit

val (-?) : unit

val (/) : unit

val (:=) : unit

val (=) : unit

val (land) : unit

Advanced Module Stuff

module CollectionModule : sig ... end

This comment is for CollectionModule.

module type COLLECTION = module type of Ocamlary.CollectionModule

module type of

module Recollection
  (C : Ocamlary.COLLECTION) : 
  Ocamlary.COLLECTION
    with type collection = C.element list
     and type element = C.collection

This comment is for CollectionModule.

module type MMM = sig ... end

module type RECOLLECTION =
  Ocamlary.MMM with module C = Ocamlary.Recollection(Ocamlary.CollectionModule)

module type RecollectionModule = sig ... end

module type A = sig ... end

module type B = sig ... end

module type C = sig ... end

This module type includes two signatures.

module FunctorTypeOf
  (Collection : module type of Ocamlary.CollectionModule) : 
  sig ... end

This comment is for FunctorTypeOf.

module type IncludeModuleType = sig ... end

This comment is for IncludeModuleType.

module type ToInclude = sig ... end

include Ocamlary.ToInclude

module IncludedA : sig ... end

module type IncludedB = sig ... end

Advanced Type Stuff

type record = {

field1 : int;
(*
This comment is for field1.
*)
field2 : int;
(*
This comment is for field2.
*)

}

This comment is for record.

This comment is also for record.

type mutable_record = {

mutable a : int;
(*
a is first and mutable
*)
b : unit;
(*
b is second and immutable
*)
mutable c : int;
(*
c is third and mutable
*)

}

type universe_record = {

nihilate : 'a. 'a -> unit;

}

type variant =

| TagA
(*
This comment is for TagA.
*)
| ConstrB of int
(*
This comment is for ConstrB.
*)
| ConstrC of int * int
(*
This comment is for binary ConstrC.
*)
| ConstrD of int * int
(*
This comment is for unary ConstrD of binary tuple.
*)

This comment is for variant.

This comment is also for variant.

type poly_variant = [

| `TagA
| `ConstrB of int

]

This comment is for poly_variant.

Wow! It was a polymorphic variant!

type (_, _) full_gadt =

| Tag : (unit, unit) Ocamlary.full_gadt
| First : 'a -> ('a, unit) Ocamlary.full_gadt
| Second : 'a -> (unit, 'a) Ocamlary.full_gadt
| Exist : 'a * 'b -> ('b, unit) Ocamlary.full_gadt

This comment is for full_gadt.

Wow! It was a GADT!

type 'a partial_gadt =

| AscribeTag : 'a Ocamlary.partial_gadt
| OfTag of 'a Ocamlary.partial_gadt
| ExistGadtTag : ('a -> 'b) -> 'a Ocamlary.partial_gadt

This comment is for partial_gadt.

Wow! It was a mixed GADT!

type alias = Ocamlary.variant

This comment is for alias.

type tuple =
  (Ocamlary.alias * Ocamlary.alias)
  * Ocamlary.alias
  * (Ocamlary.alias * Ocamlary.alias)

This comment is for tuple.

type variant_alias = Ocamlary.variant =

| TagA
| ConstrB of int
| ConstrC of int * int
| ConstrD of int * int

This comment is for variant_alias.

type record_alias = Ocamlary.record = {

field1 : int;
field2 : int;

}

This comment is for record_alias.

type poly_variant_union = [

| Ocamlary.poly_variant
| `TagC

]

This comment is for poly_variant_union.

type 'a poly_poly_variant = [

| `TagA of 'a

]

type ('a, 'b) bin_poly_poly_variant = [

| `TagA of 'a
| `ConstrB of 'b

]

type 'a open_poly_variant = [> `TagA ] as 'a

type 'a open_poly_variant2 = [> `ConstrB of int ] as 'a

type 'a open_poly_variant_alias =
  'a Ocamlary.open_poly_variant Ocamlary.open_poly_variant2

type 'a poly_fun = ([> `ConstrB of int ] as 'a) -> 'a

type 'a poly_fun_constraint = 'a -> 'a constraint 'a = [> `TagA ]

type 'a closed_poly_variant = [< `One | `Two ] as 'a

type 'a clopen_poly_variant = [< `One | `Two of int | `Three Two Three ] as 'a

type nested_poly_variant = [

| `A
| `B of [ `B1 | `B2 ]
| `C
| `D of [ `D1 of [ `D1a ] ]

]

type ('a, 'b) full_gadt_alias = ('a, 'b) Ocamlary.full_gadt =

| Tag : (unit, unit) Ocamlary.full_gadt_alias
| First : 'a -> ('a, unit) Ocamlary.full_gadt_alias
| Second : 'a -> (unit, 'a) Ocamlary.full_gadt_alias
| Exist : 'a * 'b -> ('b, unit) Ocamlary.full_gadt_alias

This comment is for full_gadt_alias.

type 'a partial_gadt_alias = 'a Ocamlary.partial_gadt =

| AscribeTag : 'a Ocamlary.partial_gadt_alias
| OfTag of 'a Ocamlary.partial_gadt_alias
| ExistGadtTag : ('a -> 'b) -> 'a Ocamlary.partial_gadt_alias

This comment is for partial_gadt_alias.

exception Exn_arrow : unit -> exn

This comment is for Exn_arrow.

type mutual_constr_a =

| A
| B_ish of Ocamlary.mutual_constr_b
(*
This comment is between mutual_constr_a and mutual_constr_b.
*)

This comment is for mutual_constr_a then mutual_constr_b.

and mutual_constr_b =

| B
| A_ish of Ocamlary.mutual_constr_a
(*
This comment must be here for the next to associate correctly.
*)

This comment is for mutual_constr_b then mutual_constr_a.

type rec_obj = < f : int ; g : unit -> unit ; h : Ocamlary.rec_obj >

type 'a open_obj = < f : int ; g : unit -> unit.. > as 'a

type 'a oof = (< a : unit.. > as 'a) -> 'a

type 'a any_obj = < .. > as 'a

type empty_obj = < >

type one_meth = < meth : unit >

type ext = ..

A mystery wrapped in an ellipsis

type Ocamlary.ext +=

| ExtA

type Ocamlary.ext +=

| ExtB

type Ocamlary.ext +=

| ExtC of unit
| ExtD of Ocamlary.ext

type Ocamlary.ext +=

| ExtE

type Ocamlary.ext += private

| ExtF

type 'a poly_ext = ..

'a poly_ext

type Ocamlary.poly_ext +=

| Foo of 'b
| Bar of 'b * 'b
(*
'b poly_ext
*)

type Ocamlary.poly_ext +=

| Quux of 'c
(*
'c poly_ext
*)

module ExtMod : sig ... end

type Ocamlary.ExtMod.t +=

| ZzzTop0
(*
It's got the rock
*)

type Ocamlary.ExtMod.t +=

| ZzzTop of unit
(*
and it packs a unit.
*)

val launch_missiles : unit -> unit

Rotate keys on my mark...

type my_mod = (module Ocamlary.COLLECTION)

A brown paper package tied up with string

class empty_class : object ... end

class one_method_class : object ... end

class two_method_class : object ... end

class 'a param_class : 'a -> object ... end

type my_unit_object = unit param_class

type 'a my_unit_class = unit param_class as 'a

module Dep1 : sig ... end

module Dep2 (Arg : sig ... end) : sig ... end

type dep1 = Dep2(Dep1).B.c

module Dep3 : sig ... end

module Dep4 : sig ... end

module Dep5 (Arg : sig ... end) : sig ... end

type dep2 = Ocamlary.Dep5(Ocamlary.Dep4).Z.X.b

type dep3 = Dep5(Dep4).Z.Y.a

module Dep6 : sig ... end

module Dep7 (Arg : sig ... end) : sig ... end

type dep4 = Ocamlary.Dep7(Ocamlary.Dep6).M.Y.d

module Dep8 : sig ... end

module Dep9 (X : sig ... end) : sig ... end

module type Dep10 = Ocamlary.Dep9(Ocamlary.Dep8).T with type t = int

module Dep11 : sig ... end

module Dep12 (Arg : sig ... end) : sig ... end

module Dep13 : Ocamlary.Dep12(Ocamlary.Dep11).T

type dep5 = Ocamlary.Dep13.c

module type With1 = sig ... end

module With2 : sig ... end

module With3 : Ocamlary.With1 with module M = Ocamlary.With2

type with1 = Ocamlary.With3.N.t

module With4 : Ocamlary.With1 with module M := Ocamlary.With2

type with2 = Ocamlary.With4.N.t

module With5 : sig ... end

module With6 : sig ... end

module With7 (X : sig ... end) : sig ... end

module type With8 =
  Ocamlary.With7(Ocamlary.With6).T
    with module M = Ocamlary.With5
     and type M.N.t = Ocamlary.With5.N.t

module With9 : sig ... end

module With10 : sig ... end

module type With11 =
  Ocamlary.With7(Ocamlary.With10).T
    with module M = Ocamlary.With9
     and type N.t = int

module type NestedInclude1 = sig ... end

include Ocamlary.NestedInclude1

module type NestedInclude2 = sig ... end

include Ocamlary.NestedInclude2 with type nested_include = int

type nested_include = int

module DoubleInclude1 : sig ... end

module DoubleInclude3 : sig ... end

include module type of Ocamlary.DoubleInclude3.DoubleInclude2

type double_include

module IncludeInclude1 : sig ... end

include module type of Ocamlary.IncludeInclude1

module type IncludeInclude2 = sig ... end

module IncludeInclude2_M : sig ... end

include Ocamlary.IncludeInclude2

type include_include

Trying the {!modules: ...} command.

With ocamldoc, toplevel units will be linked and documented, while submodules will behave as simple references.

With odoc, everything should be resolved (and linked) but only toplevel units will be documented.

Dep1.X
Ocamlary.IncludeInclude1
Ocamlary This is an interface with all of the module system features. This documentation demonstrates:

Weirder usages involving module types

Playing with @canonical paths

module CanonicalTest : sig ... end

Some ref to CanonicalTest.Base_Tests.C.t and CanonicalTest.Base_Tests.L.id. But also to CanonicalTest.Base.List and CanonicalTest.Base.List.t

Aliases again

module Aliases : sig ... end

Let's imitate jst's layout.

Section title splicing

I can refer to

{!section:indexmodules} : Trying the {!modules: ...} command.
{!aliases} : Aliases again

But also to things in submodules:

{!section:SuperSig.SubSigA.subSig} : A Labeled Section Header Inside of a Signature
{!Aliases.incl} : include of Foo

And just to make sure we do not mess up:

{{!section:indexmodules}A} : A
{{!aliases}B} : B
{{!section:SuperSig.SubSigA.subSig}C} : C
{{!Aliases.incl}D} : D

New reference syntax

module type M = sig ... end

module M : sig ... end

Here goes:

{!module-M.t} : M.t
{!module-type-M.t} : M.t

module Only_a_module : sig ... end

{!Only_a_module.t} : Only_a_module.t
{!module-Only_a_module.t} : Only_a_module.t
{!module-Only_a_module.type-t} : Only_a_module.t
{!type:Only_a_module.t} : Only_a_module.t

module type TypeExt = sig ... end

type new_t = ..

type Ocamlary.new_t +=

| C

module type TypeExtPruned = Ocamlary.TypeExt with type t := Ocamlary.new_t

module Op : sig ... end

Module Ocamlary

Level 1

Level 2

Level 3

Level 4

Basic module stuff

Section 9000

EmptySig

Basic exception stuff

Basic type and value stuff with advanced doc comments

Some Operators

Advanced Module Stuff

Advanced Type Stuff

Trying the {!modules: ...} command.

Weirder usages involving module types

Playing with @canonical paths

Aliases again

Section title splicing

New reference syntax

Module `Ocamlary`